1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Kits APIs
  5. Get data on a kit

V10.0

get

/ec-designer-ors-svc/rest/v10.0/studies/{studyId}/versions/{version}/kits/{kitId}

Retrieves data on a specific kit in a study.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Kit was retrieved successfully for the requested study version.
Body ()
Root Schema : Kits GET By Id Response v10.0
Type: object
Title: Kits GET By Id Response v10.0
Designer response envelope returned by GET kit by id.
Show Source
  • Kits GET Error
    Title: Kits GET Error
    Error payload returned inside the Designer response envelope.
  • Kits GET Kit v10.0
    Title: Kits GET Kit v10.0
    Kit details returned by the GET kits endpoint.
  • Minimum Length: 1
    Maximum Length: 32
    Allowed Values: [ "success" ]
    Envelope status returned by this endpoint. Allowed value: `success`, which indicates the Designer response wrapper was created successfully for this request.
    Example: success
  • Minimum Value: 1
    Envelope version for the shared Designer response wrapper.
    Example: 1
Nested Schema : Kits GET Error
Type: object
Title: Kits GET Error
Error payload returned inside the Designer response envelope.
Show Source
Example:
{
    "errorCode":"C1-500",
    "errorMessage":"Unable to retrieve kits for the requested study version.",
    "details":{
        "studyId":"CF1E6500073D4AD298F4DA93DA670786",
        "version":"1.0.0.1",
        "kitType":"ALL",
        "kitTypeExclude":false
    }
}
Nested Schema : Kits GET Kit v10.0
Type: object
Title: Kits GET Kit v10.0
Kit details returned by the GET kits endpoint.
Show Source
Example:
{
    "kitId":"B1B8327AFAA6412287106192AB5984EF",
    "kitSettings":{
        "deviceType":"ActivityWatch",
        "deviceConn":"DevicetoCloud",
        "calculatingDoses":true,
        "titratingDoses":false,
        "titrationKit":false,
        "distributionSetting":"BLINDED",
        "kitTypeId":"KIT_STD_001",
        "kitDescription":"Standard treatment kit",
        "storageSetting":"AMBIENT",
        "trialSupplyType":"BOTTLE",
        "minShipUnits":10,
        "serialized":true,
        "hazardousMaterial":false,
        "controlSubstance":false,
        "bufferdays":5,
        "dispenseOutsideWindow":false
    },
    "kitUnitSettings":{
        "unitsPerKit":20,
        "singleUnitDose":{
            "value":10,
            "units":"mg"
        }
    },
    "dosings":[
        {
            "id":"D1B8327AFAA6412287106192AB5984EF",
            "name":"Weight-based dose",
            "question":{
                "formId":"E1B8327AFAA6412287106192AB5984EF",
                "itemId":"F1B8327AFAA6412287106192AB5984EF"
            },
            "visit":{
                "id":"A1B8327AFAA6412287106192AB5984EF",
                "type":"ScreeningVisit"
            },
            "dose":{
                "precision":1,
                "roundUp":1,
                "frequency":"Daily",
                "leftOverUnits":false
            },
            "measurement":{
                "kit":{
                    "value":10,
                    "units":"mg"
                },
                "subject":{
                    "value":70,
                    "units":"kg"
                }
            }
        }
    ],
    "exceptions":[
        {
            "id":"91B8327AFAA6412287106192AB5984EF",
            "kitId":"B1B8327AFAA6412287106192AB5984EF",
            "sequence":1,
            "startingDoseJson":{
                "titrationKitExceptionItems":[
                    {
                        "kitId":"B1B8327AFAA6412287106192AB5984EF",
                        "kitSeq":1,
                        "kitDosage":"QD",
                        "dosageId":"D1B8327AFAA6412287106192AB5984EF"
                    }
                ]
            },
            "endingDoseJson":{
                "titrationKitExceptionItems":[
                    {
                        "kitId":"C1B8327AFAA6412287106192AB5984EF",
                        "kitSeq":2,
                        "kitDosage":"BID",
                        "dosageId":"D1B8327AFAA6412287106192AB5984EF"
                    }
                ]
            },
            "minTimeBetweenDoseChangesUnit":"Days",
            "minTimeBetweenDoseChanges":2,
            "exceptionType":"UP_EXCEPTION"
        }
    ],
    "advancedDosing":1,
    "advancedDosingGroups":[
        {
            "id":"71B8327AFAA6412287106192AB5984EF",
            "groupName":"Adults",
            "groupCriteria":[
                {
                    "id":"72B8327AFAA6412287106192AB5984EF",
                    "criteriaType":"Question",
                    "visitName":"Screening",
                    "visitId":"A1B8327AFAA6412287106192AB5984EF",
                    "formName":"Demographics",
                    "formId":"E1B8327AFAA6412287106192AB5984EF",
                    "questionName":"Age",
                    "questionId":"F1B8327AFAA6412287106192AB5984EF",
                    "variable":"System Screening Date",
                    "variableId":"73B8327AFAA6412287106192AB5984EF",
                    "timePeriod":"Before",
                    "dateValue":"2026-01-15",
                    "answer":[
                        {
                            "value":"18_PLUS",
                            "label":"18 years or older"
                        }
                    ],
                    "rule":{
                        "id":"74B8327AFAA6412287106192AB5984EF",
                        "ruleName":"Greater Than Or Equal To",
                        "value":"18",
                        "valueList":[
                            {
                                "value":"18",
                                "label":"18"
                            }
                        ],
                        "lower":{
                            "value":"18",
                            "inclusive":true
                        },
                        "upper":{
                            "value":"120",
                            "inclusive":true
                        }
                    }
                }
            ],
            "kitSettings":[
                {
                    "id":"75B8327AFAA6412287106192AB5984EF",
                    "kitId":"B1B8327AFAA6412287106192AB5984EF",
                    "kitName":"Standard treatment kit",
                    "dosingId":"D1B8327AFAA6412287106192AB5984EF",
                    "kitUnitSettings":{
                        "unitsPerKit":20,
                        "singleUnitDose":{
                            "value":10,
                            "units":"mg"
                        }
                    },
                    "dosings":[
                        {
                            "id":"D1B8327AFAA6412287106192AB5984EF",
                            "name":"Weight-based dose",
                            "question":{
                                "formId":"E1B8327AFAA6412287106192AB5984EF",
                                "itemId":"F1B8327AFAA6412287106192AB5984EF"
                            },
                            "visit":{
                                "id":"A1B8327AFAA6412287106192AB5984EF",
                                "type":"ScreeningVisit"
                            },
                            "dose":{
                                "precision":1,
                                "roundUp":1,
                                "frequency":"Daily",
                                "leftOverUnits":false
                            },
                            "measurement":{
                                "kit":{
                                    "value":10,
                                    "units":"mg"
                                },
                                "subject":{
                                    "value":70,
                                    "units":"kg"
                                }
                            }
                        }
                    ],
                    "dosingLabel":"Dose 1",
                    "quantity":1
                }
            ],
            "instructions":"Dispense one kit when the adult criteria are met."
        }
    ],
    "versionStart":"2026-01-15T10:15:30Z",
    "versionEnd":"3099-12-31T00:00:00Z",
    "studyId":"CF1E6500073D4AD298F4DA93DA670786",
    "studyVersionStart":"2026-01-15T10:15:30Z",
    "studyVersionEnd":"3099-12-31T00:00:00Z",
    "libraryKitId":"C1B8327AFAA6412287106192AB5984EF",
    "poolingId":"POOL12",
    "isDefault":true,
    "dosage":50
}
Nested Schema : Kits GET Error Details
Type: object
Title: Kits GET Error Details
Request values echoed back in the error payload for troubleshooting.
Show Source
  • Minimum Length: 3
    Maximum Length: 21
    Allowed Values: [ "ALL", "STANDARD", "TITRATION", "DEVICE", "advancedDispensation" ]
    Kit type filter from the request. Allowed values: `ALL` for every kit type, `STANDARD` for standard kits, `TITRATION` for titration kits, `DEVICE` for device kits, and `advancedDispensation` for advanced dispensation kits.
    Example: ALL
  • Whether the request excluded the selected kit type instead of including it.
    Example: false
  • Minimum Length: 32
    Maximum Length: 32
    Study identifier from the request.
  • Minimum Length: 1
    Maximum Length: 32
    Study version from the request.
    Example: 1.0.0.1
Example:
{
    "studyId":"CF1E6500073D4AD298F4DA93DA670786",
    "version":"1.0.0.1",
    "kitType":"ALL",
    "kitTypeExclude":false
}
Nested Schema : advancedDosingGroups
Type: array
Minimum Number of Items: 0
Advanced dosing groups that define criteria-based kit selection rules.
Show Source
Nested Schema : dosings
Type: array
Minimum Number of Items: 0
Calculated dosing definitions associated with the kit.
Show Source
Nested Schema : exceptions
Type: array
Minimum Number of Items: 0
Titration exceptions configured for the kit.
Show Source
Nested Schema : Kits GET Kit Settings v10.0
Type: object
Title: Kits GET Kit Settings v10.0
Kit settings returned by GET kits.
Show Source
  • Minimum Value: 0
    Buffer days for dispensing calculations.
    Example: 5
  • Whether the kit uses calculated dosing.
    Example: true
  • Whether the kit is a controlled substance.
    Example: false
  • Minimum Length: 1
    Maximum Length: 32
    Allowed Values: [ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]
    Device connectivity type for device kits. `CloudtoCloud` means the device syncs through a third-party cloud service, `DevicetoCloud` means the device sends data directly to the platform cloud, and `NoConnection` means the device has no connectivity requirement.
    Example: DevicetoCloud
  • Minimum Length: 1
    Maximum Length: 64
    Allowed Values: [ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]
    Device type for device kits. Allowed values: ActivityWatch, BloodPressureMonitor, WeightScale, ECGReader, Spirometer, MobileApp, SmartPillBottle, PulseOximeter, WearablePatch, Other, GlucoseMonitor.
    Example: ActivityWatch
  • Whether to dispense on an up-titration request when the subject is already at the highest dose.
    Example: true
  • Minimum Length: 1
    Maximum Length: 1024
    Message shown when a subject is already at the highest dose.
    Example: Subject is already at the highest dose.
  • Whether to dispense on a down-titration request when the subject is already at the lowest dose.
    Example: true
  • Minimum Length: 1
    Maximum Length: 1024
    Message shown when a subject is already at the lowest dose.
    Example: Subject is already at the lowest dose.
  • Whether the kit can be dispensed outside the visit window.
    Example: false
  • Minimum Length: 1
    Maximum Length: 32
    Allowed Values: [ "BLINDED", "UNBLINDED", "UNBLINDEDPHARMAC" ]
    Distribution setting for the kit. `BLINDED` hides treatment assignment, `UNBLINDED` exposes treatment assignment, and `UNBLINDEDPHARMAC` is unblinded for pharmacy-managed dispensing workflows.
    Example: BLINDED
  • Whether dose changes are allowed at unscheduled visits.
    Example: false
  • Whether titration dosing frequency is configured.
    Example: true
  • Minimum Value: 0
    Maximum number of down-titration dose changes.
    Example: 2
  • Minimum Value: 0
    Maximum number of down-titration dose changes allowed for unscheduled visits.
    Example: 2
  • Whether the kit is hazardous material.
    Example: false
  • Minimum Length: 1
    Maximum Length: 255
    Kit description displayed to users.
    Example: Standard treatment kit
  • Minimum Length: 1
    Maximum Length: 64
    Kit type identifier.
    Example: KIT_STD_001
  • Minimum Value: 0
    Maximum number of total dose changes.
    Example: 3
  • Minimum Value: 0
    Minimum number of ship units required for this kit.
    Example: 10
  • Whether the kit is serialized.
    Example: true
  • Minimum Length: 1
    Maximum Length: 32
    Allowed Values: [ "AMBIENT", "FROZEN", "REFRIGERATED" ]
    Storage setting for the kit. `AMBIENT` means room-temperature storage, `FROZEN` means frozen storage, and `REFRIGERATED` means refrigerated storage.
    Example: AMBIENT
  • Minimum Value: 0
    Minimum time required between down-dose changes.
    Example: 20
  • Whether an exception is allowed for the time between down-dose changes.
    Example: true
  • Minimum Length: 1
    Maximum Length: 16
    Allowed Values: [ "Days", "Hours" ]
    Unit used for the time between down-dose changes. `Days` measures the interval in calendar days and `Hours` measures the interval in hours.
    Example: Days
  • Minimum Value: 0
    Minimum time required between up-dose changes.
    Example: 20
  • Whether an exception is allowed for the time between up-dose changes.
    Example: true
  • Minimum Length: 1
    Maximum Length: 16
    Allowed Values: [ "Days", "Hours" ]
    Unit used for the time between up-dose changes. `Days` measures the interval in calendar days and `Hours` measures the interval in hours.
    Example: Days
  • Whether the kit supports titration dosing.
    Example: false
  • Whether the kit itself is a titration kit.
    Example: false
  • Minimum Value: 0
    Maximum number of total dose changes allowed for unscheduled visits.
    Example: 3
  • Minimum Length: 1
    Maximum Length: 32
    Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]
    Trial supply type for the kit. Allowed values: BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX, OTHER.
    Example: BOTTLE
  • Minimum Value: 0
    Maximum number of up-titration dose changes.
    Example: 1
  • Minimum Value: 0
    Maximum number of up-titration dose changes allowed for unscheduled visits.
    Example: 1
Nested Schema : kitTitrations
Type: array
Minimum Number of Items: 0
Titration rows configured for the kit.
Show Source
Example:
[
    {
        "rowId":"81B8327AFAA6412287106192AB5984EF",
        "titrationKitId":"B1B8327AFAA6412287106192AB5984EF",
        "titrationKitLabel":"Low Dose",
        "titrationKitSeq":1,
        "titrationKitJson":{
            "titrationKitItems":[
                {
                    "kitId":"B1B8327AFAA6412287106192AB5984EF",
                    "kitSeq":1,
                    "kitDosage":"QD",
                    "dosageId":"D1B8327AFAA6412287106192AB5984EF"
                }
            ]
        },
        "upTitrationKitJson":{
            "titrationKitItems":[
                {
                    "kitId":"B1B8327AFAA6412287106192AB5984EF",
                    "kitSeq":1,
                    "kitDosage":"QD",
                    "dosageId":"D1B8327AFAA6412287106192AB5984EF"
                }
            ]
        },
        "maintainTitrationKitJson":{
            "titrationKitItems":[
                {
                    "kitId":"B1B8327AFAA6412287106192AB5984EF",
                    "kitSeq":1,
                    "kitDosage":"QD",
                    "dosageId":"D1B8327AFAA6412287106192AB5984EF"
                }
            ]
        },
        "downTitrationKitJson":{
            "titrationKitItems":[
                {
                    "kitId":"B1B8327AFAA6412287106192AB5984EF",
                    "kitSeq":1,
                    "kitDosage":"QD",
                    "dosageId":"D1B8327AFAA6412287106192AB5984EF"
                }
            ]
        }
    }
]
Nested Schema : Kits GET Kit Unit Settings v10.0
Type: object
Title: Kits GET Kit Unit Settings v10.0
Unit settings returned by GET kits.
Show Source
Nested Schema : Kits GET Advanced Dosing Group v10.0
Type: object
Title: Kits GET Advanced Dosing Group v10.0
Advanced dosing group definition.
Show Source
Nested Schema : groupCriteria
Type: array
Minimum Number of Items: 0
Criteria that determine whether the group applies.
Show Source
Nested Schema : kitSettings
Type: array
Minimum Number of Items: 0
Kit settings applied when the group criteria are satisfied.
Show Source
Nested Schema : Kits GET Advanced Dosing Criterion v10.0
Type: object
Title: Kits GET Advanced Dosing Criterion v10.0
Advanced dosing group criterion.
Show Source
  • answer
    Minimum Number of Items: 0
    Selected answer values for choice-based criteria.
  • Minimum Length: 1
    Maximum Length: 32
    Allowed Values: [ "Question", "Dates", "Cohort", "Treatment Arm", "invalid" ]
    Criterion type. `Question` evaluates a form response, `Dates` evaluates a date variable, `Cohort` matches cohort membership, `Treatment Arm` matches arm assignment, and `invalid` represents an unrecognized persisted value.
    Example: Question
  • Minimum Length: 10
    Maximum Length: 10
    Date value used by date-based criteria in `YYYY-MM-DD` format.
    Example: 2026-01-15
  • Minimum Length: 32
    Maximum Length: 32
    Form identifier associated with the criterion.
  • Minimum Length: 1
    Maximum Length: 255
    Form name associated with the criterion.
    Example: Demographics
  • Minimum Length: 32
    Maximum Length: 32
    Criterion identifier.
  • Minimum Length: 32
    Maximum Length: 32
    Question identifier associated with the criterion.
  • Minimum Length: 1
    Maximum Length: 255
    Question name associated with the criterion.
    Example: Age
  • Kits GET Rule v10.0
    Title: Kits GET Rule v10.0
    Advanced dosing evaluation rule.
  • Minimum Length: 1
    Maximum Length: 16
    Allowed Values: [ "After", "Before", "invalid" ]
    Time period qualifier used by date-based criteria. `After` means the event occurs after the supplied date, `Before` means it occurs before the supplied date, and `invalid` represents an unrecognized persisted value.
    Example: Before
  • Minimum Length: 1
    Maximum Length: 255
    Variable label associated with the criterion.
    Example: System Screening Date
  • Minimum Length: 32
    Maximum Length: 32
    Variable identifier associated with the criterion.
  • Minimum Length: 32
    Maximum Length: 32
    Visit identifier associated with the criterion.
  • Minimum Length: 1
    Maximum Length: 255
    Visit name associated with the criterion.
    Example: Screening
Nested Schema : answer
Type: array
Minimum Number of Items: 0
Selected answer values for choice-based criteria.
Show Source
Nested Schema : Kits GET Rule v10.0
Type: object
Title: Kits GET Rule v10.0
Advanced dosing evaluation rule.
Show Source
Nested Schema : Kits GET Label Value v10.0
Type: object
Title: Kits GET Label Value v10.0
Label and value pair used across advanced dosing rules.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Display label.
    Example: 18 years or older
  • Minimum Length: 1
    Maximum Length: 255
    Stored value.
    Example: 18_PLUS
Nested Schema : Kits GET Range Rule Boundary v10.0
Type: object
Title: Kits GET Range Rule Boundary v10.0
Boundary value for a range-based rule.
Show Source
Nested Schema : valueList
Type: array
Minimum Number of Items: 0
List of allowed rule values for list-based rules.
Show Source
Nested Schema : Kits GET Advanced Dosing Kit Settings v10.0
Type: object
Title: Kits GET Advanced Dosing Kit Settings v10.0
Kit settings used inside an advanced dosing group.
Show Source
Nested Schema : dosings
Type: array
Minimum Number of Items: 0
Calculated dosing definitions for the selected kit.
Show Source
Nested Schema : Kits GET Kit Dosing v10.0
Type: object
Title: Kits GET Kit Dosing v10.0
Calculated dosing definition returned by GET kits.
Show Source
Nested Schema : Kits GET Dose Settings v10.0
Type: object
Title: Kits GET Dose Settings v10.0
Dose calculation settings.
Show Source
Nested Schema : Kits GET Dosing Measurement v10.0
Type: object
Title: Kits GET Dosing Measurement v10.0
Kit and subject measurements used for dose calculation.
Show Source
Nested Schema : Kits GET Dosing Question v10.0
Type: object
Title: Kits GET Dosing Question v10.0
Form question reference used by a dosing definition.
Show Source
Nested Schema : Kits GET Dosing Visit v10.0
Type: object
Title: Kits GET Dosing Visit v10.0
Visit reference used by a dosing definition.
Show Source
  • Minimum Length: 32
    Maximum Length: 32
    Visit identifier.
  • Minimum Length: 1
    Maximum Length: 64
    Allowed Values: [ "ScreeningVisit", "ScheduleAbleVisit", "SubjectWithdrawalVisit", "SubjectCompletionVisit", "UnScheduleAbleVisit", "Event", "AdverseEvent", "ScreenFailureVisit", "ReScreeningEvent" ]
    Visit type for the dosing source visit. Allowed values: ScreeningVisit, ScheduleAbleVisit, SubjectWithdrawalVisit, SubjectCompletionVisit, UnScheduleAbleVisit, Event, AdverseEvent, ScreenFailureVisit, ReScreeningEvent.
    Example: ScreeningVisit
Nested Schema : Kits GET Value Units v10.0
Type: object
Title: Kits GET Value Units v10.0
Value and unit pair used by dosing and kit unit settings.
Show Source
Nested Schema : Kits GET Titration Exception v10.0
Type: object
Title: Kits GET Titration Exception v10.0
Titration exception returned by GET kits.
Show Source
Nested Schema : Kits GET Titration Exception Items v10.0
Type: object
Title: Kits GET Titration Exception Items v10.0
Collection of titration kit items used by an exception.
Show Source
Example:
{
    "titrationKitExceptionItems":[
        {
            "kitId":"B1B8327AFAA6412287106192AB5984EF",
            "kitSeq":1,
            "kitDosage":"QD",
            "dosageId":"D1B8327AFAA6412287106192AB5984EF"
        }
    ]
}
Nested Schema : titrationKitExceptionItems
Type: array
Minimum Number of Items: 0
Titration kit items used by the exception.
Show Source
Example:
[
    {
        "kitId":"B1B8327AFAA6412287106192AB5984EF",
        "kitSeq":1,
        "kitDosage":"QD",
        "dosageId":"D1B8327AFAA6412287106192AB5984EF"
    }
]
Nested Schema : Kits GET Titration Kit Item v10.0
Type: object
Title: Kits GET Titration Kit Item v10.0
Titration kit item returned by GET kits.
Show Source
Nested Schema : Kits GET Titration Group v10.0
Type: object
Title: Kits GET Titration Group v10.0
Titration group row returned by GET kits.
Show Source
Nested Schema : Kits GET Titration Items v10.0
Type: object
Title: Kits GET Titration Items v10.0
Collection of titration kit items.
Show Source
Example:
{
    "titrationKitItems":[
        {
            "kitId":"B1B8327AFAA6412287106192AB5984EF",
            "kitSeq":1,
            "kitDosage":"QD",
            "dosageId":"D1B8327AFAA6412287106192AB5984EF"
        }
    ]
}
Nested Schema : titrationKitItems
Type: array
Minimum Number of Items: 0
Titration kit items in the current group.
Show Source
Example:
[
    {
        "kitId":"B1B8327AFAA6412287106192AB5984EF",
        "kitSeq":1,
        "kitDosage":"QD",
        "dosageId":"D1B8327AFAA6412287106192AB5984EF"
    }
]
Examples

500 Response

Returned when the service cannot load the requested kit or evaluate its validation details for the supplied study version because of an unexpected server-side failure.
Body ()
Root Schema : ErrorResponseData
Type: object
Show Source
Nested Schema : details
Type: object
Back to Top