Jump to

• Request
• Response

Create randomization list

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/randlist/generate

Generates a randomization list in the study; Rights: DesignerRandListPost.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of the study
• studyVersion(required): string
  Version of the study

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request Object to create randomization list

Show Source

• blocksPerCohort: integer (int32)
  Minimum Value: 1

  Maximum Value: 500000

  Number of blocks per cohort.

  Example: 5
• blocksPerStratum: integer (int32)
  Minimum Value: 1

  Maximum Value: 500000

  Number of blocks per stratum.

  Example: 5
• blocksPerStratumPerCohort: integer (int32)
  Minimum Value: 1

  Maximum Value: 500000

  Number of blocks per stratum per cohort.

  Example: 5
• description: string
  Minimum Length: 0

  Maximum Length: 2000

  Description of randomization list

  Example: Randomization list with demographic cohort
• initialRandNumber(required): integer (int64)
  Minimum Value: 1

  Maximum Value: 99999999

  Starting number.

  Example: 1
• mode: string
  Mode of the study, accepts: test, active, or training

  Example: test, active, or training
• noOfRows: integer (int32)
  Minimum Value: 1

  Maximum Value: 500000

  Number of blocks.

  Example: 5
• srcId(required): string (uuid)
  Unique Id.
• srcVersionStart(required): string (date-time)
  Version Start
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Title of randomization list

  Example: UPL_RL191_V1001
• treatmentRatioMultiplier(required): integer (int32)
  Minimum Value: 1

  Maximum Value: 99

  Multiplier for blocks.

  Example: 5

{
    "required":[
        "initialRandNumber",
        "srcId",
        "srcVersionStart",
        "title",
        "treatmentRatioMultiplier"
    ],
    "type":"object",
    "properties":{
        "title":{
            "maxLength":"64",
            "minLength":"1",
            "type":"string",
            "description":"Title of randomization list",
            "example":"UPL_RL191_V1001"
        },
        "description":{
            "maxLength":"2000",
            "minLength":"0",
            "type":"string",
            "description":"Description of randomization list",
            "example":"Randomization list with demographic cohort"
        },
        "treatmentRatioMultiplier":{
            "maximum":"99",
            "minimum":"1",
            "type":"integer",
            "description":"Multiplier for blocks.",
            "format":"int32",
            "example":"5"
        },
        "initialRandNumber":{
            "maximum":"99999999",
            "minimum":"1",
            "type":"integer",
            "description":"Starting number.",
            "format":"int64",
            "example":"1"
        },
        "srcId":{
            "type":"string",
            "description":"Unique Id.",
            "format":"uuid"
        },
        "srcVersionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "noOfRows":{
            "maximum":"500000",
            "minimum":"1",
            "type":"integer",
            "description":"Number of blocks.",
            "format":"int32",
            "example":"5"
        },
        "blocksPerStratum":{
            "maximum":"500000",
            "minimum":"1",
            "type":"integer",
            "description":"Number of blocks per stratum.",
            "format":"int32",
            "example":"5"
        },
        "blocksPerCohort":{
            "maximum":"500000",
            "minimum":"1",
            "type":"integer",
            "description":"Number of blocks per cohort.",
            "format":"int32",
            "example":"5"
        },
        "blocksPerStratumPerCohort":{
            "maximum":"500000",
            "minimum":"1",
            "type":"integer",
            "description":"Number of blocks per stratum per cohort.",
            "format":"int32",
            "example":"5"
        },
        "mode":{
            "type":"string",
            "description":"Mode of the study, accepts: test, active, or training",
            "example":"test, active, or training"
        }
    },
    "description":"Request Object to create randomization list"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : GenerateResponse

Type: object

Response Object for created randomization list.

Show Source

• listId: string
  Unique Id of generated randomization list

  Example: 9ECA4FA65076451DA7D47D59367D15A5
• noOfRowsGenerated: integer (int32)
  Number of rows generated for randomization list.

  Example: 5

{
    "type":"object",
    "properties":{
        "listId":{
            "type":"string",
            "description":"Unique Id of generated randomization list",
            "example":"9ECA4FA65076451DA7D47D59367D15A5"
        },
        "noOfRowsGenerated":{
            "type":"integer",
            "description":"Number of rows generated for randomization list.",
            "format":"int32",
            "example":"5"
        }
    },
    "description":"Response Object for created randomization list."
}

400 Response

For algorithm not defined for the randomization design or randomization design not associated with a visit

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

For Invalid study ID or version

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