Jump to

• Request
• Response

v5.0

get

/ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/randlists/{rndlistid}

Retrieves a randomization list by ID. This API version returns useSequenceNumber to identify whether a given randomization list has a Sequence Number or not. Rights: OrsRandListGet and OrsUnblinded.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• rndlistid(required): string
  ID of the randomization list.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : RandListTO v5.0

Type: object

Title: RandListTO v5.0

Contains randomization list details.

Show Source

• blockedBy: string
  Randomization list blocked by type of randomization

  Example: none,country,region,site
• description: string
  Description of randomization list

  Example: Randomization list with demographic cohort
• firstAssctdRandDesignSrcId: string (uuid)
  Title: First Associated Randomization Design ID

  Unique Id for the first associated randomization design.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef
• firstAssctdStudyVersion: string
  Title: First Associated Study Version

  Version of the first associated study.

  Example: 1.0.1
• inUse: string
  Is randomization list is in use

  Example: n,y
• isBlocked: string
  Is randomization list for blocked algorithm

  Example: n,y
• isCohortBased: string
  Indicates whether the randomization is cohort based.

  Example: n,y
• isDynamic: string
  Is randomization list dynamic

  Example: n,y
• isMinimization: string
  Title: Minimization List

  Is randomization list for minimization randomization design

  Example: n,y
• isStratified: string
  Is randomization list stratified

  Example: n,y
• lastAssctdRandDesignSrcId: string (uuid)
  Title: Last Associated Randomization Design ID

  Unique Id for the last associated randomization design.
• lastAssctdStudyVersion: string (UUID)
  Title: Last Associated Study Version

  Version of the last associated study

  Example: 1.0.1
• name: string
  Name of randomization list

  Example: UPL_RL191_V1001
• randListId: string (uuid)
  Unique ID for randomization list.

  Example: 00000000-0000-0000-0000-000000000001
• useSequenceNumber: string
  Indicates whether the randomization list includes a sequence number.

  Example: y
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.

  Example: 2025-01-02T08:00:00Z
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2025-01-01T12:34:56Z

{
    "title":"RandListTO v5.0",
    "type":"object",
    "properties":{
        "randListId":{
            "type":"string",
            "description":"Unique ID for randomization list.",
            "format":"uuid",
            "example":"00000000-0000-0000-0000-000000000001"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2025-01-01T12:34:56Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time",
            "example":"2025-01-02T08:00:00Z"
        },
        "name":{
            "type":"string",
            "description":"Name of randomization list",
            "example":"UPL_RL191_V1001"
        },
        "description":{
            "type":"string",
            "description":"Description of randomization list",
            "example":"Randomization list with demographic cohort"
        },
        "isStratified":{
            "type":"string",
            "description":"Is randomization list stratified",
            "example":"n,y"
        },
        "isBlocked":{
            "type":"string",
            "description":"Is randomization list for blocked algorithm",
            "example":"n,y"
        },
        "isDynamic":{
            "type":"string",
            "description":"Is randomization list dynamic",
            "example":"n,y"
        },
        "inUse":{
            "type":"string",
            "description":"Is randomization list is in use",
            "example":"n,y"
        },
        "blockedBy":{
            "type":"string",
            "description":"Randomization list blocked by type of randomization",
            "example":"none,country,region,site"
        },
        "isCohortBased":{
            "type":"string",
            "description":"Indicates whether the randomization is cohort based.",
            "example":"n,y"
        },
        "isMinimization":{
            "title":"Minimization List",
            "type":"string",
            "description":"Is randomization list for minimization randomization design",
            "example":"n,y"
        },
        "lastAssctdRandDesignSrcId":{
            "title":"Last Associated Randomization Design ID",
            "type":"string",
            "description":"Unique Id for the last associated randomization design.",
            "format":"uuid"
        },
        "lastAssctdStudyVersion":{
            "title":"Last Associated Study Version",
            "type":"string",
            "description":"Version of the last associated study",
            "format":"UUID",
            "example":"1.0.1"
        },
        "useSequenceNumber":{
            "type":"string",
            "description":"Indicates whether the randomization list includes a sequence number.",
            "example":"y"
        },
        "firstAssctdRandDesignSrcId":{
            "title":"First Associated Randomization Design ID",
            "type":"string",
            "description":"Unique Id for the first associated randomization design.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "firstAssctdStudyVersion":{
            "title":"First Associated Study Version",
            "type":"string",
            "description":"Version of the first associated study.",
            "example":"1.0.1"
        }
    },
    "description":"Contains randomization list details."
}

404 Response

Appears for invalid study ID, invalid study version or if a randomization list isn't 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

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