Jump to

• Request
• Response

[Deprecated]: v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders-inventory/audit

Deprecated: Retrieves all order items.
Rights: OrsInventoryGet, OrsUnblinded.

Request

Path Parameters

• 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:

  C36A3197FDEE433FB5547EE83DE99E4B

Query Parameters

• limit(required): integer(int32)
  Minimum Value: 1
• offset(required): integer(int32)
  Minimum Value: 0

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object OrderItemResponse
  Title: OrderItemResponse

  Contains order items in paginated format.

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

Nested Schema : OrderItemResponse

Type: object

Title: OrderItemResponse

Contains order items in paginated format.

Show Source

• count: integer (int32)
  Minimum Value: 0

  Number of results in the current page.

  Example: 25
• hasMore: boolean
  Indicates if there are more results beyond the current page.

  Example: true
• limit: integer (int32)
  Minimum Value: 1

  Maximum Value: 500

  Maximum number of records returned per page.

  Example: 50
• offset: integer (int32)
  Minimum Value: 0

  Index of the first record returned in the current page.

  Example: 0
• resultData: array resultData
  Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs.
• totalResults: integer (int32)
  Minimum Value: 0

  Total number of results across all pages.

  Example: 125

{
    "title":"OrderItemResponse",
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more results beyond the current page.",
            "example":true
        },
        "totalResults":{
            "minimum":0,
            "type":"integer",
            "description":"Total number of results across all pages.",
            "format":"int32",
            "example":125
        },
        "count":{
            "minimum":0,
            "type":"integer",
            "description":"Number of results in the current page.",
            "format":"int32",
            "example":25
        },
        "limit":{
            "maximum":500,
            "minimum":1,
            "type":"integer",
            "description":"Maximum number of records returned per page.",
            "format":"int32",
            "example":50
        },
        "offset":{
            "minimum":0,
            "type":"integer",
            "description":"Index of the first record returned in the current page.",
            "format":"int32",
            "example":0
        },
        "resultData":{
            "type":"array",
            "description":"Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs.",
            "example":[
                {
                    "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/OrderItemTO"
            }
        }
    },
    "description":"Contains order items in paginated format."
}

Nested Schema : resultData

Type: array

Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs.

Show Source

• Array of: object OrderItemTO v1.0
  Title: OrderItemTO v1.0

  Contains order item details.

{
    "type":"array",
    "description":"Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs.",
    "example":[
        {
            "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/OrderItemTO"
    }
}

Example:

[
    {
        "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A"
    }
]

Nested Schema : OrderItemTO v1.0

Type: object

Title: OrderItemTO v1.0

Contains order item details.

Show Source

• comment: string
  Title: Comment

  Comment.
• inventoryId: string (uuid)
  Title: Inventory ID

  Inventory ID.
• inventoryVersionStart: string (date-time)
  Title: Version Start

  Inventory version start.
• objectVersionNumber: number
  Title: Object Version Number

  Object version number.
• operationType: string
  Title: Operation Type

  Operation type.
• orderId: string (uuid)
  Title: Order ID

  Order ID.
• orderItemId: string (uuid)
• orderVersionStart: string (date-time)
  Title: Version Start

  Order version start date.
• reason: string
  Title: Reason

  Reason.
• softwareVersionNumber: number
  Title: Software Version Number

  Software version number.
• userId: string (uuid)
  Title: User ID

  User ID.
• versionEnd: string (date-time)
  Title: Version End

  Version end date.
• versionStart: string (date-time)
  Title: Version Start

  Version start date.

{
    "title":"OrderItemTO v1.0",
    "type":"object",
    "properties":{
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Version start date.",
            "format":"date-time"
        },
        "versionEnd":{
            "title":"Version End",
            "type":"string",
            "description":"Version end date.",
            "format":"date-time"
        },
        "inventoryId":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        },
        "inventoryVersionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Inventory version start.",
            "format":"date-time"
        },
        "orderId":{
            "title":"Order ID",
            "type":"string",
            "description":"Order ID.",
            "format":"uuid"
        },
        "orderVersionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Order version start date.",
            "format":"date-time"
        },
        "operationType":{
            "title":"Operation Type",
            "type":"string",
            "description":"Operation type."
        },
        "objectVersionNumber":{
            "title":"Object Version Number",
            "type":"number",
            "description":"Object version number."
        },
        "softwareVersionNumber":{
            "title":"Software Version Number",
            "type":"number",
            "description":"Software version number."
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"Reason."
        },
        "comment":{
            "title":"Comment",
            "type":"string",
            "description":"Comment."
        },
        "orderItemId":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Contains order item details.",
    "example":[
        {
            "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A"
        }
    ]
}

Example:

[
    {
        "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A"
    }
]

Examples

Select an example Get Order Items Response

400 Response

Bad request.

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 Bad Request

404 Response

Invalid study ID

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 Not Found

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 Server Error

Back to Top