Create a visit

Make a POST request to create a visit and start defining the visit schedule.

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.

Step 1: Create the request payload file

The JSON file below contains an example of what a screening visit payload would look like for this API call.

Create a new JSON file called Screening.json and copy the following:

{
    "fullName": "Screening Visit",
    "id": null,
    "title": "Screening Visit",
    "repeatVisit": false,
    "repeatNumber": 0,
    "requiredVisit": true,
    "randomization": null,
    "lastRequired": false,
    "eventType": "ScreeningVisit",
    "shortName": "SCR"
}

Step 2: Create visit using payload file

Run the following cURL call to create a new scheduled visit using the request payload file.

curl -X POST "https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits" -d "@Screening.json"

To make subsequent calls for this specific visit, take note of the visit's id value.

For more information on how to build the payload request body and other parameters see Add a visit.

Once you are done, create as many visits as you need. To define the visit schedule, you will need another visit to schedule it from.

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.