REST API for Clinical One Platform

Get all manufacturing lots

get

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/lots/manufacturing-lots

Retrieves all manufacturing 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

includeDeleted: boolean
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 ManufacturingLotCommonTO

Title: ManufacturingLotCommonTO

Manufacturing Lot details

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

Nested Schema : ManufacturingLotCommonTO

Type: object

Title: ManufacturingLotCommonTO

Manufacturing Lot details

Show Source

blindedLotId: string (uuid)

Blinded lot id
blindedLotVersionStart: string (date-time)

Blinded lot version start date
comment: string

Comment.

Example: Some comment
doNotCount: number (BigDecimal)

Do not count(DNC) days

Example: 10
doNotShip: number (BigDecimal)

Do not ship(DNS) days

Example: 10
expirationDate: string (date-time)

Expiration date
inUse: boolean

If lot is in use or not

Example: true
kitTypeSrcId: string (uuid)

kitType SrcId
lotId: string (uuid)

Lot id
lotNumber: string

Lot number

Example: Lot1001
manufacturingLotNumber: string

Manufacturing lot number

Example: Mlot1001
materialId: string (String)

materialId

Example: 1234
objectVersionNumber: number (double)

Object Version Number.

Example: 5
operationType: string

Allowed Values: [ "CREATED", "REMOVED", "MODIFIED" ]

Operation type.

Example: MODIFIED
quantity: number (BigDecimal)

Quantity

Example: 10
reason: string

Reason.

Example: Some reason
runNumber: string

Run number

Example: run number 01
softwareVersionNumber: number (double)

Software Version Number.

Example: 2
userId: string (uuid)

User id
versionEnd: string (date-time)

Version End
versionStart: string (date-time)

Version Start

{
    "title":"ManufacturingLotCommonTO",
    "type":"object",
    "properties":{
        "manufacturingLotNumber":{
            "type":"string",
            "description":"Manufacturing lot number",
            "example":"Mlot1001"
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date",
            "format":"date-time"
        },
        "blindedLotId":{
            "type":"string",
            "description":"Blinded lot id",
            "format":"uuid"
        },
        "doNotCount":{
            "type":"number",
            "description":"Do not count(DNC) days",
            "format":"BigDecimal",
            "example":10
        },
        "doNotShip":{
            "type":"number",
            "description":"Do not ship(DNS) days",
            "format":"BigDecimal",
            "example":10
        },
        "lotNumber":{
            "type":"string",
            "description":"Lot number",
            "example":"Lot1001"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "description":"User id",
            "format":"uuid"
        },
        "runNumber":{
            "type":"string",
            "description":"Run number",
            "example":"run number 01"
        },
        "inUse":{
            "type":"boolean",
            "description":"If lot is in use or not",
            "example":true
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "blindedLotVersionStart":{
            "type":"string",
            "description":"Blinded lot version start date",
            "format":"date-time"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type.",
            "example":"MODIFIED",
            "enum":[
                "CREATED",
                "REMOVED",
                "MODIFIED"
            ]
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object Version Number.",
            "format":"double",
            "example":5
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software Version Number.",
            "format":"double",
            "example":2
        },
        "reason":{
            "type":"string",
            "description":"Reason.",
            "example":"Some reason"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Some comment"
        },
        "quantity":{
            "type":"number",
            "description":"Quantity",
            "format":"BigDecimal",
            "example":10
        },
        "materialId":{
            "type":"string",
            "description":"materialId",
            "format":"String",
            "example":"1234"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"kitType SrcId",
            "format":"uuid"
        },
        "lotId":{
            "type":"string",
            "description":"Lot id",
            "format":"uuid"
        }
    },
    "description":"Manufacturing Lot details"
}

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