Jump to

• Request
• Response

Upload kit types data

post

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

Uploads kit types data. Rights: DesignerKitListUpload.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Contains inventory upload detail.

Show Source

• containsHeader: boolean
• containsHeadersRow(required): string
  Pattern: [yYnN]

  Contains header row

  Example: y/n
• fileId(required): string (uuid)
  Unique Id for field.
• headerMappings: array headerMappings
  Title: headerMappings

  Header mapping.
• headerMappingsMap: object headerMappingsMap
  Additional Properties Allowed: HeaderMapping
• kitTypeMappings: array kitTypeMappings
  Title: kitTypeMappings

  Kit type mapping.

{
    "required":[
        "containsHeadersRow",
        "fileId"
    ],
    "type":"object",
    "properties":{
        "fileId":{
            "type":"string",
            "description":"Unique Id for field.",
            "format":"uuid"
        },
        "containsHeadersRow":{
            "pattern":"[yYnN]",
            "type":"string",
            "description":"Contains header row",
            "example":"y/n"
        },
        "headerMappings":{
            "title":"headerMappings",
            "type":"array",
            "description":"Header mapping.",
            "items":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        },
        "kitTypeMappings":{
            "title":"kitTypeMappings",
            "type":"array",
            "description":"Kit type mapping.",
            "items":{
                "$ref":"#/components/schemas/KitTypeMapping"
            }
        },
        "containsHeader":{
            "type":"boolean"
        },
        "headerMappingsMap":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        }
    },
    "description":"Contains inventory upload detail."
}

Nested Schema : headerMappings

Type: array

Title: headerMappings

Header mapping.

Show Source

• Array of: object HeaderMapping
  Contains header mapping.

{
    "title":"headerMappings",
    "type":"array",
    "description":"Header mapping.",
    "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 : kitTypeMappings

Type: array

Title: kitTypeMappings

Kit type mapping.

Show Source

• Array of: object KitTypeMapping
  Contains kit type mapping.

{
    "title":"kitTypeMappings",
    "type":"array",
    "description":"Kit type mapping.",
    "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."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : InvUploadKitTypeResponse

Type: object

Contains inventory upload kit type response.

Show Source

• kitTypes: array kitTypes
  Title: kitTypes

  Contains kit types.

{
    "type":"object",
    "properties":{
        "kitTypes":{
            "title":"kitTypes",
            "type":"array",
            "description":"Contains kit types.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Contains inventory upload kit type response."
}

Nested Schema : kitTypes

Type: array

Title: kitTypes

Contains kit types.

Show Source

• Array of: string

{
    "title":"kitTypes",
    "type":"array",
    "description":"Contains kit types.",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid CSV file format,data, or header mappings

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

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

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

Back to Top