Jump to

• Request
• Response

v4.0

put

/ec-ors-svc/rest/v4.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.

  Example:

  AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

• 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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Lot Request

Type: object

Title: Lot Request

Request containing lot details.

Show Source

• depotId: string (uuid)
  Depot id for pooled lot quantity.
• doNotCount: number (BigDecimal)
  Title: Do Not Count

  Minimum Value: 0

  Maximum Value: 999

  Do Not Count (DNC) days.

  Example: 10
• doNotShip: number (BigDecimal)
  Title: Do Not Ship

  Minimum Value: 0

  Maximum Value: 999

  Do Not Ship (DNS) days.

  Example: 10
• expirationDate(required): string
  Title: Expiration Date

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

  Expiration date.

  Example: 2025-12-31
• kitTypeSrcId: string (uuid)
  Kit type ID.
• lotNumber: string
  Title: Lot Number

  Minimum Length: 0

  Maximum Length: 50

  Lot number.

  Example: LOT-001
• manufacturingLotNumber(required): string
  Title: Manufacturing Lot Number

  Minimum Length: 0

  Maximum Length: 50

  Manufacturing lot number.

  Example: LOT-001
• materialId: string (String)
  Minimum Length: 0

  Maximum Length: 255

  Material ID.

  Example: 1234
• quantity: number (BigDecimal)
  Title: Quantity

  Minimum Value: 1

  Kit quantity.

  Example: 10
• updateDepotId: boolean
  Set to true to update the depot id.

  Example: true
• updateKitTypeId: boolean
  Whether to update the kit type ID.

  Example: true
• updateMaterialId: boolean
  Whether to update the material ID.

  Example: true

{
    "title":"Lot Request",
    "required":[
        "expirationDate",
        "manufacturingLotNumber"
    ],
    "type":"object",
    "properties":{
        "manufacturingLotNumber":{
            "title":"Manufacturing Lot Number",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Manufacturing lot number.",
            "example":"LOT-001"
        },
        "lotNumber":{
            "title":"Lot Number",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Lot number.",
            "example":"LOT-001"
        },
        "expirationDate":{
            "title":"Expiration Date",
            "pattern":"(\\d){4}-(\\d){2}-(\\d){2}",
            "type":"string",
            "description":"Expiration date.",
            "example":"2025-12-31"
        },
        "doNotShip":{
            "title":"Do Not Ship",
            "maximum":999,
            "minimum":0,
            "type":"number",
            "description":"Do Not Ship (DNS) days.",
            "format":"BigDecimal",
            "example":10
        },
        "doNotCount":{
            "title":"Do Not Count",
            "maximum":999,
            "minimum":0,
            "type":"number",
            "description":"Do Not Count (DNC) days.",
            "format":"BigDecimal",
            "example":10
        },
        "quantity":{
            "title":"Quantity",
            "minimum":1,
            "type":"number",
            "description":"Kit quantity.",
            "format":"BigDecimal",
            "example":10
        },
        "materialId":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Material ID.",
            "format":"String",
            "example":"1234"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "updateMaterialId":{
            "type":"boolean",
            "description":"Whether to update the material ID.",
            "example":true
        },
        "updateKitTypeId":{
            "type":"boolean",
            "description":"Whether to update the kit type ID.",
            "example":true
        },
        "depotId":{
            "type":"string",
            "description":"Depot id for pooled lot quantity.",
            "format":"uuid"
        },
        "updateDepotId":{
            "type":"boolean",
            "description":"Set to true to update the depot id.",
            "example":true
        }
    },
    "description":"Request containing lot details."
}

Examples

Select an example Update Manufacturing Lot Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : IDResponse v1.0

Type: object

Title: IDResponse v1.0

Response containing the identifier.

Show Source

• id: string (uuid)
  ID

{
    "title":"IDResponse v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        }
    },
    "description":"Response containing the identifier."
}

400 Response

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

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

403 Response

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

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top