REST API for Clinical One Platform

Create blinded lot

post

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

Creates a blinded lot by study ID. Rights: LotManagementPost.

Request

Path Parameters

mode(required): string

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

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

blindedLotNumber(required): string

Minimum Length: 0

Maximum Length: 50

Blinded lot number

Example: Bld-Lt-AZ
doNotCount: number (BigDecimal)

Minimum Value: 0

Maximum Value: 99999

Do not count(DNC) days

Example: 10
doNotShip: number (BigDecimal)

Minimum Value: 0

Maximum Value: 99999

Do not ship(DNS) days

Example: 50
expirationDate(required): string

Pattern: (\d){4}-(\d){2}-(\d){2}

Expiration date of Blinded lot

Example: 2022-04-01T00:00:00.000Z
manufacturingLotIds: array manufacturingLotIds
releaseForDepotToDepot: boolean
settingsByCountry: array settingsByCountry
shortName: string

Minimum Length: 0

Maximum Length: 50

Blinded lot short name

Example: BlindedLot-01

{
    "required":[
        "blindedLotNumber",
        "expirationDate"
    ],
    "type":"object",
    "properties":{
        "blindedLotNumber":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string",
            "description":"Blinded lot number",
            "example":"Bld-Lt-AZ"
        },
        "shortName":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string",
            "description":"Blinded lot short name",
            "example":"BlindedLot-01"
        },
        "expirationDate":{
            "pattern":"(\\d){4}-(\\d){2}-(\\d){2}",
            "type":"string",
            "description":"Expiration date of Blinded lot",
            "example":"2022-04-01T00:00:00.000Z"
        },
        "doNotShip":{
            "maximum":"99999",
            "minimum":"0",
            "type":"number",
            "description":"Do not ship(DNS) days",
            "format":"BigDecimal",
            "example":"50"
        },
        "doNotCount":{
            "maximum":"99999",
            "minimum":"0",
            "type":"number",
            "description":"Do not count(DNC) days",
            "format":"BigDecimal",
            "example":"10"
        },
        "manufacturingLotIds":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "settingsByCountry":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CountrySupplySettings"
            }
        },
        "releaseForDepotToDepot":{
            "type":"boolean"
        }
    }
}

Nested Schema : manufacturingLotIds

Type: array

Show Source

Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : settingsByCountry

Type: array

Show Source

Array of: object CountrySupplySettings

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

Nested Schema : CountrySupplySettings

Type: object

Show Source

countryIso(required): string
doNotCount(required): number (BigDecimal)

Minimum Value: 0

Maximum Value: 99999

Do not count(DNC) days

Example: 10
doNotShip(required): number (BigDecimal)

Minimum Value: 0

Maximum Value: 99999

Do not ship(DNS) days

Example: 50

{
    "required":[
        "countryIso",
        "doNotCount",
        "doNotShip"
    ],
    "type":"object",
    "properties":{
        "countryIso":{
            "type":"string"
        },
        "doNotShip":{
            "maximum":"99999",
            "minimum":"0",
            "type":"number",
            "description":"Do not ship(DNS) days",
            "format":"BigDecimal",
            "example":"50"
        },
        "doNotCount":{
            "maximum":"99999",
            "minimum":"0",
            "type":"number",
            "description":"Do not count(DNC) days",
            "format":"BigDecimal",
            "example":"10"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : BlindedLotId

Type: object

Contains blinded lot id.

Show Source

id: string (uuid)

Unique Id for blinded lot.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique Id for blinded lot.",
            "format":"uuid"
        }
    },
    "description":"Contains blinded lot id."
}

400 Response

Blinded lot number or lot short name already exists. OR Expiration date is not valid. OR Invalid lot. OR Lot belongs to a blinded lot.

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

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