REST API for Clinical One Platform

Get list of blinded lots

get

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

Retrieves list of blinded lots by study ID. Rights: LotManagementGet.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study

Query Parameters

limit: integer(int32)

Maximum number of records to display per page.
offset: integer(int32)

An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object BlindedLots

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BlindedLots"
    }
}

Nested Schema : BlindedLots

Type: object

Show Source

blindedLotNumber: string

Blinded lot number

Example: Blot1001
comment: string
doNotCount: number (BigDecimal)

doNotCount

Example: 10
doNotShip: number (BigDecimal)

doNotShip

Example: 10
expirationDate: string (date-time)

Blinded lot expiration date
id: string (uuid)

Unique id for blinded lot
inUse: boolean
manufacturingLotIds: array manufacturingLotIds

Title: manufacturingLotIds

Contains manufactoring lot id.
objectVersionNumber: number
operationType: string
reason: string
releaseForDepotToDepot: boolean
settingsByCountry: array settingsByCountry
shortName: string

Blinded lot short name

Example: Blot1001
softwareVersionNumber: number
userId: string (uuid)
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique id for blinded lot",
            "format":"uuid"
        },
        "blindedLotNumber":{
            "type":"string",
            "description":"Blinded lot number",
            "example":"Blot1001"
        },
        "shortName":{
            "type":"string",
            "description":"Blinded lot short name",
            "example":"Blot1001"
        },
        "expirationDate":{
            "type":"string",
            "description":"Blinded lot expiration date",
            "format":"date-time"
        },
        "doNotShip":{
            "type":"number",
            "description":"doNotShip",
            "format":"BigDecimal",
            "example":"10"
        },
        "doNotCount":{
            "type":"number",
            "description":"doNotCount",
            "format":"BigDecimal",
            "example":"10"
        },
        "manufacturingLotIds":{
            "title":"manufacturingLotIds",
            "type":"array",
            "description":"Contains manufactoring lot id.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "inUse":{
            "type":"boolean"
        },
        "settingsByCountry":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SettingsByCountry"
            }
        },
        "releaseForDepotToDepot":{
            "type":"boolean"
        }
    }
}

Nested Schema : manufacturingLotIds

Type: array

Title: manufacturingLotIds

Contains manufactoring lot id.

Show Source

Array of: string(uuid)

{
    "title":"manufacturingLotIds",
    "type":"array",
    "description":"Contains manufactoring lot id.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : settingsByCountry

Type: array

Show Source

Array of: object SettingsByCountry

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SettingsByCountry"
    }
}

Nested Schema : SettingsByCountry

Type: object

Show Source

countryIso: string
doNotCount: number
doNotShip: number
id: string (uuid)
userId: string (uuid)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "countryIso":{
            "type":"string"
        },
        "doNotCount":{
            "type":"number"
        },
        "doNotShip":{
            "type":"number"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

403 Response

The study identifier does not match any study identifiers in Clinical One

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

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