REST API for Clinical One Platform

Get non-serialized inventory order items

get

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

Retrieves all order items for non-serilaized inventory.
Rights: OrsInventoryGet, OrsUnblinded.

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

audit(required): boolean
limit: integer(int32)

Minimum Value: 1
nsInventoryId: string(uuid)
offset: integer(int32)

Minimum Value: 0
orderId: string(uuid)

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 NSOrderInventoryResponse

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

Nested Schema : NSOrderInventoryResponse

Type: object

Show Source

count: integer (int32)
hasMore: boolean
limit: integer (int32)
offset: integer (int32)
resultData: array resultData
totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "resultData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderNSInventoryTO"
            }
        }
    }
}

Nested Schema : resultData

Type: array

Show Source

Array of: object OrderNSInventoryTO

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

Nested Schema : OrderNSInventoryTO

Type: object

Show Source

comment: string
lotId: string (uuid)
lotNumber: string
nsInventoryId: string (uuid)
nsInventoryVersionStart: string (date-time)
objectVersionNumber: number
operationType: string
orderId: string (uuid)
orderItemId: string (uuid)
orderVersionStart: string (date-time)
quantity: number
reason: string
shipmentNumber: string
softwareVersionNumber: number
transactionId: string (uuid)
userId: string (uuid)
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "orderItemId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "nsInventoryId":{
            "type":"string",
            "format":"uuid"
        },
        "nsInventoryVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "orderId":{
            "type":"string",
            "format":"uuid"
        },
        "transactionId":{
            "type":"string",
            "format":"uuid"
        },
        "orderVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "quantity":{
            "type":"number"
        },
        "shipmentNumber":{
            "type":"string"
        },
        "lotNumber":{
            "type":"string"
        },
        "lotId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

404 Response

Invalid study ID

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