Jump to

• Request
• Response

v4.0

get

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

Retrieves manufacturing lot by lot ID. Rights: LotManagementGet.

Request

Path Parameters

• id(required): string
  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

Query Parameters

• includeDeleted: boolean
  Include deleted records.

  Example:

  false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ManufacturingLotCommonTO

Type: object

Title: ManufacturingLotCommonTO

Manufacturing Lot details

Show Source

• blindedLotId: string (uuid)
  Title: Blinded Lot ID

  Blinded lot ID.
• blindedLotVersionStart: string (date-time)
  Blinded lot version start date.
• comment: string
  Comment.

  Example: Some comment
• doNotCount: number (BigDecimal)
  Title: Do Not Count

  Do Not Count (DNC) days.

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

  Do Not Ship (DNS) days.

  Example: 10
• expirationDate: string (date-time)
  Title: Expiration Date

  Expiration date.
• inUse: boolean
  Indicates whether the lot is in use.

  Example: true
• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

  Kit type ID.
• lotId: string (uuid)
  Title: Lot ID

  Lot ID.
• lotNumber: string
  Title: Lot Number

  Lot number.

  Example: Lot1001
• manufacturingLotNumber: string
  Title: Manufacturing Lot Number

  Manufacturing lot number.

  Example: Mlot1001
• materialId: string (String)
  Title: Material ID

  Material ID.

  Example: 1234
• objectVersionNumber: number (BigDecimal)
  Object version number.

  Example: 5
• operationType: string
  Allowed Values: [ "CREATED", "REMOVED", "MODIFIED" ]

  Operation type.

  Example: MODIFIED
• quantity: number (double)
  Title: Quantity

  Kit quantity.

  Example: 10
• reason: string
  Reason.

  Example: Some reason
• runNumber: string
  Run number.

  Example: run number 01
• softwareVersionNumber: number (BigDecimal)
  Software version number.

  Example: 2
• userId: string (uuid)
  User ID.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "title":"ManufacturingLotCommonTO",
    "type":"object",
    "properties":{
        "manufacturingLotNumber":{
            "title":"Manufacturing Lot Number",
            "type":"string",
            "description":"Manufacturing lot number.",
            "example":"Mlot1001"
        },
        "expirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date.",
            "format":"date-time"
        },
        "blindedLotId":{
            "title":"Blinded Lot ID",
            "type":"string",
            "description":"Blinded lot ID.",
            "format":"uuid"
        },
        "doNotCount":{
            "title":"Do Not Count",
            "type":"number",
            "description":"Do Not Count (DNC) days.",
            "format":"BigDecimal",
            "example":10
        },
        "doNotShip":{
            "title":"Do Not Ship",
            "type":"number",
            "description":"Do Not Ship (DNS) days.",
            "format":"BigDecimal",
            "example":10
        },
        "lotNumber":{
            "title":"Lot Number",
            "type":"string",
            "description":"Lot number.",
            "example":"Lot1001"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "description":"User ID.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "runNumber":{
            "type":"string",
            "description":"Run number.",
            "example":"run number 01"
        },
        "inUse":{
            "type":"boolean",
            "description":"Indicates whether the lot is in use.",
            "example":true
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "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":"BigDecimal",
            "example":5
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number.",
            "format":"BigDecimal",
            "example":2
        },
        "reason":{
            "type":"string",
            "description":"Reason.",
            "example":"Some reason"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Some comment"
        },
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity.",
            "format":"double",
            "example":10
        },
        "materialId":{
            "title":"Material ID",
            "type":"string",
            "description":"Material ID.",
            "format":"String",
            "example":"1234"
        },
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        }
    },
    "description":"Manufacturing Lot details"
}

Examples

Select an example Get Manufacturing Lot Response

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Get Manufacturing Lot Forbidden Response

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Get Manufacturing Lot Server Error Response

Back to Top