Jump to

• Request
• Response

v1.0

post

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

Uploads a randomization list in Oracle Clinical One Platform based on the mapped headers and treatment, cohort, stratum mappings. Rights: DesignerRandListUpload.

Request

Path Parameters

• 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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Randomization List Upload Request

Type: object

Title: Randomization List Upload Request

Contains randomization list mapping detail such as headers, treatment, stratums and cohorts.

Show Source

• cohortMappings: array cohortMappings
• containsHeader: boolean
• containsHeadersRow(required): string
  Allowed Values: [ "y", "n", "Y", "N" ]

  Pattern: [yYnN]

  Contains Headers Row.

  Example: y
• fileId(required): string (uuid)
  Unique ID for field.
• headerMappings: array headerMappings
• headerMappingsMap: object headerMappingsMap
  Additional Properties Allowed: HeaderMapping
• stratumMappings: array stratumMappings
• treatmentMappings: array treatmentMappings

{
    "title":"Randomization List Upload Request",
    "required":[
        "containsHeadersRow",
        "fileId"
    ],
    "type":"object",
    "properties":{
        "fileId":{
            "type":"string",
            "description":"Unique ID for field.",
            "format":"uuid"
        },
        "containsHeadersRow":{
            "pattern":"[yYnN]",
            "type":"string",
            "description":"Contains Headers Row.",
            "example":"y",
            "enum":[
                "y",
                "n",
                "Y",
                "N"
            ]
        },
        "headerMappings":{
            "type":"array",
            "example":[
                {
                    "csvHeader":"Treatment",
                    "targetField":"treatment"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        },
        "treatmentMappings":{
            "type":"array",
            "example":[
                {
                    "sourceValue":"TRT-A",
                    "targetValue":"Treatment A"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/DataMapping"
            }
        },
        "stratumMappings":{
            "type":"array",
            "example":[
                {
                    "sourceValue":"Male",
                    "targetValue":"Male"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/DataMapping"
            }
        },
        "cohortMappings":{
            "type":"array",
            "example":[
                {
                    "sourceValue":"Cohort-1",
                    "targetValue":"Cohort 1"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/DataMapping"
            }
        },
        "headerMappingsMap":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/HeaderMapping"
            }
        },
        "containsHeader":{
            "type":"boolean"
        }
    },
    "description":"Contains randomization list mapping detail such as headers, treatment, stratums and cohorts."
}

Nested Schema : cohortMappings

Type: array

Show Source

• Array of: object DataMapping
  Contains data mapping.

{
    "type":"array",
    "example":[
        {
            "sourceValue":"Cohort-1",
            "targetValue":"Cohort 1"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/DataMapping"
    }
}

Example:

[
    {
        "sourceValue":"Cohort-1",
        "targetValue":"Cohort 1"
    }
]

Nested Schema : headerMappings

Type: array

Show Source

• Array of: object HeaderMapping
  Title: HeaderMapping

  Contains header mapping.

{
    "type":"array",
    "example":[
        {
            "csvHeader":"Treatment",
            "targetField":"treatment"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/HeaderMapping"
    }
}

Example:

[
    {
        "csvHeader":"Treatment",
        "targetField":"treatment"
    }
]

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

Type: array

Show Source

• Array of: object DataMapping
  Contains data mapping.

{
    "type":"array",
    "example":[
        {
            "sourceValue":"Male",
            "targetValue":"Male"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/DataMapping"
    }
}

Example:

[
    {
        "sourceValue":"Male",
        "targetValue":"Male"
    }
]

Nested Schema : treatmentMappings

Type: array

Show Source

• Array of: object DataMapping
  Contains data mapping.

{
    "type":"array",
    "example":[
        {
            "sourceValue":"TRT-A",
            "targetValue":"Treatment A"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/DataMapping"
    }
}

Example:

[
    {
        "sourceValue":"TRT-A",
        "targetValue":"Treatment A"
    }
]

Nested Schema : DataMapping

Type: object

Contains data mapping.

Show Source

• dataFromFile: string
  Data from file.

  Example: TA
• dataId: string (uuid)
  Unique data Id.

{
    "type":"object",
    "properties":{
        "dataFromFile":{
            "type":"string",
            "description":"Data from file.",
            "example":"TA"
        },
        "dataId":{
            "type":"string",
            "description":"Unique data Id.",
            "format":"uuid"
        }
    },
    "description":"Contains data mapping.",
    "example":{
        "sourceValue":"Cohort-1",
        "targetValue":"Cohort 1"
    }
}

Example:

{
    "sourceValue":"Cohort-1",
    "targetValue":"Cohort 1"
}

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

Examples

Select an example Upload Randomization List Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : GenerateResponse

Type: object

Title: GenerateResponse

Response object for created randomization list.

Show Source

• listId: string
  Title: List ID

  Unique ID of generated randomization list.

  Example: 9ECA4FA65076451DA7D47D59367D15A5
• noOfRowsGenerated: integer (int32)
  Title: Number of Rows Generated

  Number of rows generated for the randomization list.

  Example: 5

{
    "title":"GenerateResponse",
    "type":"object",
    "properties":{
        "listId":{
            "title":"List ID",
            "type":"string",
            "description":"Unique ID of generated randomization list.",
            "example":"9ECA4FA65076451DA7D47D59367D15A5"
        },
        "noOfRowsGenerated":{
            "title":"Number of Rows Generated",
            "type":"integer",
            "description":"Number of rows generated for the randomization list.",
            "format":"int32",
            "example":5
        }
    },
    "description":"Response object for created randomization list."
}

Examples

Select an example Upload Randomization List 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 Upload Randomization List Algorithm Missing Response Upload Randomization List Invalid CSV 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 Upload Randomization List Study Or Design Not Found Response Upload Randomization List 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 Upload Randomization List Server Error Response

Back to Top