Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/{fileId}/fileheaders

Retrieves a list of headers for a randomization list in a CSV file. Rights: DesignerRandListUpload.

Request

Path Parameters

• fileId(required): string(uuid)
  ID of the file.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• rndDesignId(required): string(uuid)
  ID of the randomization design.

  Example:

  B1B8327AFAA6412287106192AB5984EF

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyVersion(required): string
  Version of the study.

  Example:

  1

Query Parameters

• containsHeadersRow: string
  Specify whether the headers row is included. Default value is 'y'.

  Default Value: y

  Example:

  y

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : UploadCSVHeaderResponse

Type: object

Title: UploadCSVHeaderResponse

Contains CSV header response.

Show Source

• headers: array Headers
  Title: Headers

  Contains headers.

{
    "title":"UploadCSVHeaderResponse",
    "type":"object",
    "properties":{
        "headers":{
            "title":"Headers",
            "type":"array",
            "description":"Contains headers.",
            "example":[
                "Kit Number",
                "Kit Type",
                "Lot Number"
            ],
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Contains CSV header response."
}

Nested Schema : Headers

Type: array

Title: Headers

Contains headers.

Show Source

• Array of: string

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

Example:

[
    "Kit Number",
    "Kit Type",
    "Lot Number"
]

Examples

Select an example Get CSV Headers Response

400 Response

Randomization list can't be generated/uploaded as there is no algorithm for the randomization designOr you must associate the randomization design with a visit before you can create/upload a randomization list for itOr the file can't be uploaded because it contains invalid content, such as special characters, empty cells, or empty rowsOr empty CSV content

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 Get CSV Headers Bad Request Response

404 Response

Study not found. Or randomization design not found. Or design not found

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 Get CSV Headers Study Or Design Not Found Response Get CSV Headers File 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 Get CSV Headers Server Error Response

Back to Top