Create a kit type

Make a POST request to create a kit type.

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 prerequisite, see Get study information and Get visit information.

Step 1: Create the request payload file

Create a new JSON file called KitType.json and copy the following code. This kit type defineas a blister pack with 16 units of the 10mg dose.

{
    "kitSettings":
    {
        "calculatingDoses": "no",
        "distributionSetting": "BLINDED",
        "kitDescription": "Medicine 10 mg blinded",
        "kitTypeId": "A",
        "minShipUnits": 1,
        "storageSetting": "AMBIENT",
        "trialSupplyType": "BLISTERPACK"
    },
    "kitUnitSettings":
    {
        "singleUnitDose":
        {
            "units": "mg",
            "value": 10
        },
        "unitsPerKit": 16
    }
}

Step 2: Add kit type using payload file

Run the following cURL call to create the kit type.

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

To make subsequent calls for each specific kit type, take note of its id value. In order to assign a kit type to a treatment arm and to a dispensation visit using Rest APIs you will need this data.

For more information on how to build the payload and other parameters, see Add a kit in a study.

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.