REST API for Clinical One Cloud Service

~~[Deprecated]: v1.0~~

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings

Deprecated: Retrieves the study settings for a given study and mode. Rights: OrsInventoryGet.

Request

Path Parameters

mode(required): string
Indicates the operational mode of the study. Accepted values: active, test, or training.
Example:
```
test
```
studyId(required): string(uuid)
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
1BC29B36F5D64B1B95F4BDBBCEA481BE
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : SupplySettingResponse

Type: object

Title: SupplySettingResponse

Contains supply setting response detail.

Show Source

consignment: object Consignment

Title: Consignment

Contains consignment detail.
initialShipments: object InitialShipments

Title: InitialShipments

Contains initial shipment detail.
inventory: object InventorySchedule

Title: InventorySchedule

Contains inventory schedule details.
kitOrdering: object KitOrdering

Title: KitOrdering

Contains kit ordering detail.
labelGroups: string

Label group.

Example: LG-01
resupplyType: array Resupply Types

Title: Resupply Types

Resupply types.
shippingGroups: string

Shipping group.

Example: SG-01
studyIdentifier: string

Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: B1B8327AFAA6412287106192AB5984EF
studyVersionStart: string (date-time)

Study version start.

Example: 2026-02-21T08:43:01Z

{
    "title":"SupplySettingResponse",
    "type":"object",
    "properties":{
        "studyIdentifier":{
            "type":"string",
            "description":"Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start.",
            "format":"date-time",
            "example":"2026-02-21T08:43:01Z"
        },
        "initialShipments":{
            "$ref":"#/components/schemas/InitialShipments"
        },
        "resupplyType":{
            "title":"Resupply Types",
            "type":"array",
            "description":"Resupply types.",
            "example":[
                {
                    "resupplyName":"Primary",
                    "resupplyType":"MINMAX"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/ResupplyType"
            }
        },
        "inventory":{
            "$ref":"#/components/schemas/InventorySchedule"
        },
        "kitOrdering":{
            "$ref":"#/components/schemas/KitOrdering"
        },
        "labelGroups":{
            "type":"string",
            "description":"Label group.",
            "example":"LG-01"
        },
        "shippingGroups":{
            "type":"string",
            "description":"Shipping group.",
            "example":"SG-01"
        },
        "consignment":{
            "$ref":"#/components/schemas/Consignment"
        }
    },
    "description":"Contains supply setting response detail.",
    "example":{
        "studyIdentifier":"B1B8327AFAA6412287106192AB5984EF",
        "studyVersionStart":"2026-02-21T08:43:01Z",
        "initialShipments":{
            "whenToSend":"AT_SITE_ACTIVATION",
            "visitNumber":5
        },
        "resupplyType":[
            {
                "resupplyName":"Primary",
                "resupplyType":"MINMAX"
            }
        ],
        "inventory":{
            "daysToRun":{
                "sunday":false,
                "monday":true,
                "tuesday":true,
                "wednesday":true,
                "thursday":true,
                "friday":true,
                "saturday":false
            },
            "timeToRun":{
                "timeHour":2,
                "timeMinute":30,
                "timePeriod":"AM",
                "timeZone":"UTC"
            }
        },
        "kitOrdering":{
            "allowed":"Y",
            "blindingGroupsRequired":"Y",
            "kitsToPreventUnblinding":"2",
            "kitType":"BOTTLE"
        },
        "labelGroups":"LG-01",
        "shippingGroups":"SG-01",
        "consignment":{
            "enableTemperatureExecursion":"N",
            "notReceivedDaysToWaitBeforeSiteNotified":5,
            "siteCanRequestManual":"Y"
        }
    }
}

Example:

{
    "studyIdentifier":"B1B8327AFAA6412287106192AB5984EF",
    "studyVersionStart":"2026-02-21T08:43:01Z",
    "initialShipments":{
        "whenToSend":"AT_SITE_ACTIVATION",
        "visitNumber":5
    },
    "resupplyType":[
        {
            "resupplyName":"Primary",
            "resupplyType":"MINMAX"
        }
    ],
    "inventory":{
        "daysToRun":{
            "sunday":false,
            "monday":true,
            "tuesday":true,
            "wednesday":true,
            "thursday":true,
            "friday":true,
            "saturday":false
        },
        "timeToRun":{
            "timeHour":2,
            "timeMinute":30,
            "timePeriod":"AM",
            "timeZone":"UTC"
        }
    },
    "kitOrdering":{
        "allowed":"Y",
        "blindingGroupsRequired":"Y",
        "kitsToPreventUnblinding":"2",
        "kitType":"BOTTLE"
    },
    "labelGroups":"LG-01",
    "shippingGroups":"SG-01",
    "consignment":{
        "enableTemperatureExecursion":"N",
        "notReceivedDaysToWaitBeforeSiteNotified":5,
        "siteCanRequestManual":"Y"
    }
}

Nested Schema : Consignment

Type: object

Title: Consignment

Contains consignment detail.

Show Source

enableTemperatureExecursion: string

Enable temperature excursion.

Example: N
notReceivedDaysToWaitBeforeSiteNotified: integer (int32)

Days to wait before site to be notified.

Example: 5
siteCanRequestManual: string

Site can request manual.

Example: Y

{
    "title":"Consignment",
    "type":"object",
    "properties":{
        "enableTemperatureExecursion":{
            "type":"string",
            "description":"Enable temperature excursion.",
            "example":"N"
        },
        "notReceivedDaysToWaitBeforeSiteNotified":{
            "type":"integer",
            "description":"Days to wait before site to be notified.",
            "format":"int32",
            "example":5
        },
        "siteCanRequestManual":{
            "type":"string",
            "description":"Site can request manual.",
            "example":"Y"
        }
    },
    "description":"Contains consignment detail.",
    "example":{
        "enableTemperatureExecursion":"N",
        "notReceivedDaysToWaitBeforeSiteNotified":5,
        "siteCanRequestManual":"Y"
    }
}

Example:

{
    "enableTemperatureExecursion":"N",
    "notReceivedDaysToWaitBeforeSiteNotified":5,
    "siteCanRequestManual":"Y"
}

Nested Schema : InitialShipments

Type: object

Title: InitialShipments

Contains initial shipment detail.

Show Source

visitNumber: integer (int64)

Visit number.

Example: 5
whenToSend: string

When to send initial shipment.

Example: AT_SITE_ACTIVATION

{
    "title":"InitialShipments",
    "type":"object",
    "properties":{
        "whenToSend":{
            "type":"string",
            "description":"When to send initial shipment.",
            "example":"AT_SITE_ACTIVATION"
        },
        "visitNumber":{
            "type":"integer",
            "description":"Visit number.",
            "format":"int64",
            "example":5
        }
    },
    "description":"Contains initial shipment detail.",
    "example":{
        "whenToSend":"AT_SITE_ACTIVATION",
        "visitNumber":5
    }
}

Example:

{
    "whenToSend":"AT_SITE_ACTIVATION",
    "visitNumber":5
}

Nested Schema : InventorySchedule

Type: object

Title: InventorySchedule

Contains inventory schedule details.

Show Source

daysToRun: object DaysToRun

Title: DaysToRun

Days to run inventory detail.
timeToRun: object TimeToRun

Title: TimeToRun

Time to run inventory detail.

{
    "title":"InventorySchedule",
    "type":"object",
    "properties":{
        "daysToRun":{
            "$ref":"#/components/schemas/DaysToRun"
        },
        "timeToRun":{
            "$ref":"#/components/schemas/TimeToRun"
        }
    },
    "description":"Contains inventory schedule details.",
    "example":{
        "daysToRun":{
            "sunday":false,
            "monday":true,
            "tuesday":true,
            "wednesday":true,
            "thursday":true,
            "friday":true,
            "saturday":false
        },
        "timeToRun":{
            "timeHour":2,
            "timeMinute":30,
            "timePeriod":"AM",
            "timeZone":"UTC"
        }
    }
}

Example:

{
    "daysToRun":{
        "sunday":false,
        "monday":true,
        "tuesday":true,
        "wednesday":true,
        "thursday":true,
        "friday":true,
        "saturday":false
    },
    "timeToRun":{
        "timeHour":2,
        "timeMinute":30,
        "timePeriod":"AM",
        "timeZone":"UTC"
    }
}

Nested Schema : KitOrdering

Type: object

Title: KitOrdering

Contains kit ordering detail.

Show Source

allowed: string

Allowed.

Example: Y
blindingGroupsRequired: string

Indicates whether blinding groups are required.

Example: Y
kitsToPreventUnblinding: string

Kits to prevent unblinding.

Example: 2
kitType: string

Kit type.

Example: BOTTLE

{
    "title":"KitOrdering",
    "type":"object",
    "properties":{
        "allowed":{
            "type":"string",
            "description":"Allowed.",
            "example":"Y"
        },
        "blindingGroupsRequired":{
            "type":"string",
            "description":"Indicates whether blinding groups are required.",
            "example":"Y"
        },
        "kitsToPreventUnblinding":{
            "type":"string",
            "description":"Kits to prevent unblinding.",
            "example":"2"
        },
        "kitType":{
            "type":"string",
            "description":"Kit type.",
            "example":"BOTTLE"
        }
    },
    "description":"Contains kit ordering detail.",
    "example":{
        "allowed":"Y",
        "blindingGroupsRequired":"Y",
        "kitsToPreventUnblinding":"2",
        "kitType":"BOTTLE"
    }
}

Example:

{
    "allowed":"Y",
    "blindingGroupsRequired":"Y",
    "kitsToPreventUnblinding":"2",
    "kitType":"BOTTLE"
}

Nested Schema : Resupply Types

Type: array

Title: Resupply Types

Resupply types.

Show Source

Array of: object ResupplyType

Title: ResupplyType

Contains resupply detail.

{
    "title":"Resupply Types",
    "type":"array",
    "description":"Resupply types.",
    "example":[
        {
            "resupplyName":"Primary",
            "resupplyType":"MINMAX"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/ResupplyType"
    }
}

Example:

[
    {
        "resupplyName":"Primary",
        "resupplyType":"MINMAX"
    }
]

Nested Schema : DaysToRun

Type: object

Title: DaysToRun

Days to run inventory detail.

Show Source

friday: boolean

Is inventory to run on Friday.

Example: true
monday: boolean

Is inventory to run on Monday.

Example: true
saturday: boolean

Is inventory to run on Saturday.

Example: true
sunday: boolean

Is inventory to run on Sunday.

Example: true
thursday: boolean

Is inventory to run on Thursday.

Example: true
tuesday: boolean

Is inventory to run on Tuesday.

Example: true
wednesday: boolean

Is inventory to run on Wednesday.

Example: true

{
    "title":"DaysToRun",
    "type":"object",
    "properties":{
        "sunday":{
            "type":"boolean",
            "description":"Is inventory to run on Sunday.",
            "example":true
        },
        "monday":{
            "type":"boolean",
            "description":"Is inventory to run on Monday.",
            "example":true
        },
        "tuesday":{
            "type":"boolean",
            "description":"Is inventory to run on Tuesday.",
            "example":true
        },
        "wednesday":{
            "type":"boolean",
            "description":"Is inventory to run on Wednesday.",
            "example":true
        },
        "thursday":{
            "type":"boolean",
            "description":"Is inventory to run on Thursday.",
            "example":true
        },
        "friday":{
            "type":"boolean",
            "description":"Is inventory to run on Friday.",
            "example":true
        },
        "saturday":{
            "type":"boolean",
            "description":"Is inventory to run on Saturday.",
            "example":true
        }
    },
    "description":"Days to run inventory detail.",
    "example":{
        "sunday":false,
        "monday":true,
        "tuesday":true,
        "wednesday":true,
        "thursday":true,
        "friday":true,
        "saturday":false
    }
}

Example:

{
    "sunday":false,
    "monday":true,
    "tuesday":true,
    "wednesday":true,
    "thursday":true,
    "friday":true,
    "saturday":false
}

Nested Schema : TimeToRun

Type: object

Title: TimeToRun

Time to run inventory detail.

Show Source

timeHour: integer (int32)

Time in hour.

Example: 5
timeMinute: integer (int32)

Time in minute.

Example: 5
timePeriod: string

Time period.

Example: AM
timeZone: string

Time zone.

Example: UTC

{
    "title":"TimeToRun",
    "type":"object",
    "properties":{
        "timeHour":{
            "type":"integer",
            "description":"Time in hour.",
            "format":"int32",
            "example":5
        },
        "timeMinute":{
            "type":"integer",
            "description":"Time in minute.",
            "format":"int32",
            "example":5
        },
        "timePeriod":{
            "type":"string",
            "description":"Time period.",
            "example":"AM"
        },
        "timeZone":{
            "type":"string",
            "description":"Time zone.",
            "example":"UTC"
        }
    },
    "description":"Time to run inventory detail.",
    "example":{
        "timeHour":2,
        "timeMinute":30,
        "timePeriod":"AM",
        "timeZone":"UTC"
    }
}

Example:

{
    "timeHour":2,
    "timeMinute":30,
    "timePeriod":"AM",
    "timeZone":"UTC"
}

Nested Schema : ResupplyType

Type: object

Title: ResupplyType

Contains resupply detail.

Show Source

resupplyName: string

Resupply name.

Example: Primary
resupplyType: string

Resupply type.

Example: MINMAX

{
    "title":"ResupplyType",
    "type":"object",
    "properties":{
        "resupplyName":{
            "type":"string",
            "description":"Resupply name.",
            "example":"Primary"
        },
        "resupplyType":{
            "type":"string",
            "description":"Resupply type.",
            "example":"MINMAX"
        }
    },
    "description":"Contains resupply detail."
}

Examples

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Examples