Define the visit schedule

Make a POST request to define the schedule for an already created 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 Get study information.

To define the schedule for a visit, you need to have the visit already created and another visit to schedule it from. See Create a visit and make sure you save the visitId associated to each.

Step 1: Create the request payload file

The JSON file below is an example of what the payload of a visit schedule should look like.

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

Note:

Replace the visitId with the actual ID value for the visit to schedule this from. For example, if you are adding the Randomization visit schedule from the Screening visit, then use the screening visit's ID.

{
    "delay":
    {
        "days": 30,
        "hours": 0
    },
    "delayWindow":
    {
        "before":
        {
            "days": 0,
            "hours": 0
        },
        "after":
        {
            "days": 29,
            "hours": 0
        }
    },
    "outOfWindowHardStopEnforced": 0,
    "outOfWindowVisitApprovalGranted": 0,
    "projectedFromRefId": "visitId",
    "branchId": null
}

Step 2: Add visit scheduled using payload file

Run the following cURL call to define the visit schedule, using the request payload file created on step 1:

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

For more information on how to build the payload and other parameters, see Create visit schedule.

View visit schedule

Given a visitId, run the following command to get the visit schedule information:

 curl -X GET https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule"

For more details on this API, like its parameters and response objects, see Get visit schedule.

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.