REST API for Clinical One Cloud Service

v2.0

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/dbheaders/uploadkits

Retrieves inventory headers containing barcodes from the database.

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:
```
1BC29B36F5D64B1B95F4BDBBCEA481BE
```

There's no request body for this operation.

Response

Supported Media Types

200 Response

Successful operation

Root Schema : UploadDBHeaderResponse

Type: object

Title: UploadDBHeaderResponse

Contains database header response.

Show Source

dbHeaders: array DB Headers

Title: DB Headers

Database headers.

{
    "title":"UploadDBHeaderResponse",
    "type":"object",
    "properties":{
        "dbHeaders":{
            "title":"DB Headers",
            "type":"array",
            "description":"Database headers.",
            "example":[
                "Kit Type",
                "Kit Number"
            ],
            "items":{
                "type":"string",
                "example":"Kit Number"
            }
        }
    },
    "description":"Contains database header response."
}

Nested Schema : DB Headers

Type: array

Title: DB Headers

Database headers.

Show Source

Array of: string

Example: Kit Number

{
    "title":"DB Headers",
    "type":"array",
    "description":"Database headers.",
    "example":[
        "Kit Type",
        "Kit Number"
    ],
    "items":{
        "type":"string",
        "example":"Kit Number"
    }
}

Example:

[
    "Kit Type",
    "Kit Number"
]

500 Response

Internal server error

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.