Jump to

• Request
• Response

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

Supported Media Types

• application/json

Request Body - 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.",
            "example":[
                {
                    "fileHeader":"Kit Number",
                    "dbHeader":"KIT_NUMBER"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        },
        "kitTypeMappings":{
            "title":"Kit Type Mappings",
            "type":"array",
            "description":"Kit type mappings.",
            "example":[
                {
                    "kitFromFile":"KITTYPE-A",
                    "kitTypeId":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/KitTypeMapping"
            }
        },
        "headerMappingsMap":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        },
        "containsHeader":{
            "type":"boolean"
        }
    },
    "description":"Contains inventory upload details."
}

Nested Schema : Header Mappings

Type: array

Title: Header Mappings

Header mappings.

Show Source

• Array of: object HeaderMapping
  Title: HeaderMapping

  Contains header mapping.

{
    "title":"Header Mappings",
    "type":"array",
    "description":"Header mappings.",
    "example":[
        {
            "fileHeader":"Kit Number",
            "dbHeader":"KIT_NUMBER"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/HeaderMapping"
    }
}

Example:

[
    {
        "fileHeader":"Kit Number",
        "dbHeader":"KIT_NUMBER"
    }
]

Nested Schema : headerMappingsMap

Type: object

Additional Properties Allowed

Show Source

• object HeaderMapping
  Title: 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
  Title: KitTypeMapping

  Contains kit type mapping.

{
    "title":"Kit Type Mappings",
    "type":"array",
    "description":"Kit type mappings.",
    "example":[
        {
            "kitFromFile":"KITTYPE-A",
            "kitTypeId":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/KitTypeMapping"
    }
}

Example:

[
    {
        "kitFromFile":"KITTYPE-A",
        "kitTypeId":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : HeaderMapping

Type: object

Title: HeaderMapping

Contains header mapping.

Show Source

• dbHeader(required): string
  DB header

  Example: Kit Number
• fileHeader(required): string
  File header

  Example: Kit Number

{
    "title":"HeaderMapping",
    "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.",
    "example":{
        "fileHeader":"Kit Number",
        "dbHeader":"KIT_NUMBER"
    }
}

Example:

{
    "fileHeader":"Kit Number",
    "dbHeader":"KIT_NUMBER"
}

Nested Schema : KitTypeMapping

Type: object

Title: KitTypeMapping

Contains kit type mapping.

Show Source

• kitFromFile(required): string
  Kit upload from file

  Example: Kit1001
• kitTypeId(required): string (uuid)
  ID of the kit type.

{
    "title":"KitTypeMapping",
    "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.",
    "example":{
        "kitFromFile":"KITTYPE-A",
        "kitTypeId":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
}

Example:

{
    "kitFromFile":"KITTYPE-A",
    "kitTypeId":"C36A3197FDEE433FB5547EE83DE99E4B"
}

Examples

Select an example Upload Inventory List Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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."
}

Examples

Select an example Upload Inventory List Response

400 Response

Invalid CSV file format or data

Body ()

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

Examples

Select an example Upload Inventory List Invalid Header Mappings Response Upload Inventory List Invalid Kit Type Mappings Response

404 Response

Invalid study ID
Invalid file identifier

Body ()

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

Examples

Select an example Upload Inventory List Not Found Response

500 Response

Internal server error

Body ()

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

Examples

Select an example Upload Inventory List Error Response

Back to Top