REST API for Clinical One Platform

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/uploadinventory

Uploads inventory data as a CSV file. Rights: DesignerKitListUpload.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training.
studyId(required): string(uuid)

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

application/json

Root Schema : schema

Type: object

Contains inventory upload details.

Show Source

containsHeader: boolean
containsHeadersRow(required): string

Allowed Values: [ "y", "n", "Y", "N" ]

Pattern: [yYnN]

Specify whether the headers row is included. Default value is 'y'.

Example: y
fileId(required): string (uuid)

ID of the file.
headerMappings: array Header Mappings

Title: Header Mappings

Header mappings.
headerMappingsMap: object headerMappingsMap

Additional Properties Allowed: HeaderMapping
kitTypeMappings: array Kit Type Mappings

Title: Kit Type Mappings

Kit type mappings.

{
    "required":[
        "containsHeadersRow",
        "fileId"
    ],
    "type":"object",
    "properties":{
        "fileId":{
            "type":"string",
            "description":"ID of the file.",
            "format":"uuid"
        },
        "containsHeadersRow":{
            "pattern":"[yYnN]",
            "type":"string",
            "description":"Specify whether the headers row is included. Default value is 'y'.",
            "example":"y",
            "enum":[
                "y",
                "n",
                "Y",
                "N"
            ]
        },
        "headerMappings":{
            "title":"Header Mappings",
            "type":"array",
            "description":"Header mappings.",
            "items":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        },
        "kitTypeMappings":{
            "title":"Kit Type Mappings",
            "type":"array",
            "description":"Kit type mappings.",
            "items":{
                "$ref":"#/components/schemas/KitTypeMapping"
            }
        },
        "containsHeader":{
            "type":"boolean"
        },
        "headerMappingsMap":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        }
    },
    "description":"Contains inventory upload details."
}

Nested Schema : Header Mappings

Type: array

Title: Header Mappings

Header mappings.

Show Source

Array of: object HeaderMapping

Contains header mapping.

{
    "title":"Header Mappings",
    "type":"array",
    "description":"Header mappings.",
    "items":{
        "$ref":"#/components/schemas/HeaderMapping"
    }
}

Nested Schema : headerMappingsMap

Type: object

Additional Properties Allowed

Show Source

object HeaderMapping

Contains header mapping.

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/HeaderMapping"
    }
}

Nested Schema : Kit Type Mappings

Type: array

Title: Kit Type Mappings

Kit type mappings.

Show Source

Array of: object KitTypeMapping

Contains kit type mapping.

{
    "title":"Kit Type Mappings",
    "type":"array",
    "description":"Kit type mappings.",
    "items":{
        "$ref":"#/components/schemas/KitTypeMapping"
    }
}

Nested Schema : HeaderMapping

Type: object

Contains header mapping.

Show Source

dbHeader(required): string

DB header

Example: Kit Number
fileHeader(required): string

File header

Example: Kit Number

{
    "required":[
        "dbHeader",
        "fileHeader"
    ],
    "type":"object",
    "properties":{
        "fileHeader":{
            "type":"string",
            "description":"File header",
            "example":"Kit Number"
        },
        "dbHeader":{
            "type":"string",
            "description":"DB header",
            "example":"Kit Number"
        }
    },
    "description":"Contains header mapping."
}

Nested Schema : KitTypeMapping

Type: object

Contains kit type mapping.

Show Source

kitFromFile(required): string

Kit upload from file

Example: Kit1001
kitTypeId(required): string (uuid)

ID of the kit type.

{
    "required":[
        "kitFromFile",
        "kitTypeId"
    ],
    "type":"object",
    "properties":{
        "kitFromFile":{
            "type":"string",
            "description":"Kit upload from file",
            "example":"Kit1001"
        },
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        }
    },
    "description":"Contains kit type mapping."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : GenerateKitsResponse

Type: object

Title: GenerateKitsResponse

Response object for kit generation.

Show Source

inventorySourceId: string

Title: Inventory Source ID

Unique ID of the inventory source.

Example: B1B8327AFAA6412287106192AB5984EF
noOfKitsGenerated: integer (int64)

Title: Number of Kits Generated

Number of kits generated.

Example: 10

{
    "title":"GenerateKitsResponse",
    "type":"object",
    "properties":{
        "inventorySourceId":{
            "title":"Inventory Source ID",
            "type":"string",
            "description":"Unique ID of the inventory source.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "noOfKitsGenerated":{
            "title":"Number of Kits Generated",
            "type":"integer",
            "description":"Number of kits generated.",
            "format":"int64",
            "example":10
        }
    },
    "description":"Response object for kit generation."
}

400 Response

Invalid CSV file format or data

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

404 Response

Invalid study ID
Invalid file identifier

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