REST API for Clinical One Platform

Update kit status

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/status

Updates kit status. Rights: OrsInventoryPost and OrsUnblinded.

Request

Path Parameters

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 kit status.

Show Source

inventoryStatusId(required): integer (int32)

Inventory status id

Example: 5
kitFilters: object KitFiltersRequest

Kit filter request
kits: array kits

Title: kits

Kit id.
reason: string

Minimum Length: 0

Maximum Length: 255

Reason of update

Example: kit damaged by subject

{
    "required":[
        "inventoryStatusId"
    ],
    "type":"object",
    "properties":{
        "kitFilters":{
            "$ref":"#/components/schemas/KitFiltersRequest"
        },
        "kits":{
            "title":"kits",
            "type":"array",
            "description":"Kit id.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason of update",
            "example":"kit damaged by subject"
        },
        "inventoryStatusId":{
            "type":"integer",
            "description":"Inventory status id",
            "format":"int32",
            "example":5
        }
    },
    "description":"Request object for kit status."
}

Nested Schema : KitFiltersRequest

Type: object

Kit filter request

Show Source

blockNumber: string

blockNumber

Example: 1
kitNumber: string

Kit Number

Example: abc-2
kitRange: string

Kit range

Example: SEQUENCE_NUMBER:900:1200
kitStatus: string

Kit status id

Example: 1
kitTypeIds: array kitTypeIds

kitTypeIds
labelGroupId: string

Label group id

Example: B1B8327AFAA6412287106192AB5984EF
location: string

Location

Example: ALL_SITES
lotId: string

Lot id

Example: B1B8327AFAA6412287106192AB5984EF
tempExcursionNumber: string

tempExcursionNumber

Example: 1

{
    "type":"object",
    "properties":{
        "location":{
            "type":"string",
            "description":"Location",
            "example":"ALL_SITES"
        },
        "lotId":{
            "type":"string",
            "description":"Lot id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitStatus":{
            "type":"string",
            "description":"Kit status id",
            "example":"1"
        },
        "kitRange":{
            "type":"string",
            "description":"Kit range",
            "example":"SEQUENCE_NUMBER:900:1200"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitNumber":{
            "type":"string",
            "description":"Kit Number",
            "example":"abc-2"
        },
        "blockNumber":{
            "type":"string",
            "description":"blockNumber",
            "example":"1"
        },
        "kitTypeIds":{
            "type":"array",
            "description":"kitTypeIds",
            "example":[
                "3F6567865E694182BEEA2B4F76538F05",
                "461A0B8261454C1EBA56285BB538E7B5",
                "EB2B77004EF74E479B6DDBA56D8B6A51"
            ],
            "items":{
                "type":"string",
                "description":"kitTypeIds",
                "format":"uuid"
            }
        },
        "tempExcursionNumber":{
            "type":"string",
            "description":"tempExcursionNumber",
            "example":"1"
        }
    },
    "description":"Kit filter request"
}

Nested Schema : kits

Type: array

Title: kits

Kit id.

Show Source

Array of: string(uuid)

{
    "title":"kits",
    "type":"array",
    "description":"Kit id.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : kitTypeIds

Type: array

kitTypeIds

Show Source

Array of: string(uuid)

kitTypeIds

{
    "type":"array",
    "description":"kitTypeIds",
    "example":[
        "3F6567865E694182BEEA2B4F76538F05",
        "461A0B8261454C1EBA56285BB538E7B5",
        "EB2B77004EF74E479B6DDBA56D8B6A51"
    ],
    "items":{
        "type":"string",
        "description":"kitTypeIds",
        "format":"uuid"
    }
}

Example:

[
    "3F6567865E694182BEEA2B4F76538F05",
    "461A0B8261454C1EBA56285BB538E7B5",
    "EB2B77004EF74E479B6DDBA56D8B6A51"
]

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 kit OR Specify at least one filter OR Either kits or kitFilters is required OR Invalid Inventory Status OR All kits should have same inventory status OR Invalid inventory status transition

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

404 Response

Invalid study ID or version

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object