Add form to visit
Make a POST request to associate a form with a visit.
Note:
- To run these Oracle Clinical One Platform API calls, you need to include an authentication token. For instructions on how to generate your authentication token, see Get a token for authentication and Use the token to make an API request.
- For every API call make sure you construct the URL using the correct server URL and path parameters values.
For the following API calls, you need the studyID
and
version
. These values are retrieved as part of a previous task, see Create a study or Get study information.
To add a form to a visit, you also need the formID
and
visitID
generated and recorded as part of previous tasks. See Create a form and Create a visit.
Step 1: Create the request payload file
The request body of this API call needs to include the ID of the visit that you want to add the form to.
Note:
Replace thevisitId
with the actual ID value for the visit. For example,
if you are adding a form to the Screening visit, then use the screening visit's
ID.
[
{
"id":"visitId"
}
]
Step 2: Associate form with a visit
Given a formId
, run the following cURL call to add a form to your visit
using the request payload file:
curl -X POST "https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}/visits" -d "@FormToVisit.json"
For more information on how to build the payload request body and other parameters see Process visits to associate with a specific form.
See visits associated with a form
Given a formId
, run the following cURL call to see what visits your form
is associated with:
curl -X GET https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}/visits"
For more details on this API, like its parameters and response objects, see Get visits associated with a form.
Tip:
Browse for these and other related APIs under the Tasks section of this guide. If you see any deprecated endpoint, look for its newest version.