REST API for Clinical One Platform

Update manufacturing lot by ID

put

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

Update manufacturing lot by a lot's ID. Rights: LotManagementPost.

Request

Path Parameters

id(required): string(uuid)

ID of the lot
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

Request object for lot.

Show Source

doNotCount: number (BigDecimal)

Minimum Value: 0

Maximum Value: 999

Do not count(DNC) days

Example: 10
doNotShip: number (BigDecimal)

Minimum Value: 0

Maximum Value: 999

Do not ship(DNS) days

Example: 10
expirationDate(required): string

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

Expiration date
kitTypeSrcId: string (uuid)

kitType SrcId
lotNumber: string

Minimum Length: 0

Maximum Length: 50

Lot number
manufacturingLotNumber(required): string

Minimum Length: 0

Maximum Length: 50

Manufacturing lot number
materialId: string (String)

Minimum Length: 0

Maximum Length: 255

materialId

Example: 1234
quantity: number (BigDecimal)

Minimum Value: 1

Quantity

Example: 10
updateKitTypeId: boolean

update KitTypeId

Example: true
updateMaterialId: boolean

update MaterialId

Example: true

{
    "required":[
        "expirationDate",
        "manufacturingLotNumber"
    ],
    "type":"object",
    "properties":{
        "manufacturingLotNumber":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string",
            "description":"Manufacturing lot number"
        },
        "lotNumber":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string",
            "description":"Lot number"
        },
        "expirationDate":{
            "pattern":"(\\d){4}-(\\d){2}-(\\d){2}",
            "type":"string",
            "description":"Expiration date"
        },
        "doNotShip":{
            "maximum":"999",
            "minimum":"0",
            "type":"number",
            "description":"Do not ship(DNS) days",
            "format":"BigDecimal",
            "example":"10"
        },
        "doNotCount":{
            "maximum":"999",
            "minimum":"0",
            "type":"number",
            "description":"Do not count(DNC) days",
            "format":"BigDecimal",
            "example":"10"
        },
        "quantity":{
            "minimum":"1",
            "type":"number",
            "description":"Quantity",
            "format":"BigDecimal",
            "example":"10"
        },
        "materialId":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"materialId",
            "format":"String",
            "example":"1234"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"kitType SrcId",
            "format":"uuid"
        },
        "updateMaterialId":{
            "type":"boolean",
            "description":"update MaterialId",
            "example":true
        },
        "updateKitTypeId":{
            "type":"boolean",
            "description":"update KitTypeId",
            "example":true
        }
    },
    "description":"Request object for lot."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : IDResponse

Type: object

Response object containing Id.

Show Source

id: string (uuid)

Id

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id",
            "format":"uuid"
        }
    },
    "description":"Response object containing Id."
}

400 Response

Invalid expiration date. OR Manufacturing Lot Number already exists or Lot short name (lotNumber) already exists.

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