Show Source

• blockedBy: string
  Randomizatyion 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)
  Unique Id for the first associated randomization design.
• firstAssctdStudyVersion: string (UUID)
  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
  Is randomization cohort based

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

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

  Example: n,y
• name: string
  Name of randomization list

  Example: UPL_RL191_V1001
• randListId: string (uuid)
  Unique ID for randomization list.
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "title":"RandListTO v3.0",
    "type":"object",
    "properties":{
        "randListId":{
            "type":"string",
            "description":"Unique ID for randomization list.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "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":"Randomizatyion list blocked  by type of Randomization",
            "example":"none,country,region,site"
        },
        "isCohortBased":{
            "type":"string",
            "description":"Is randomization cohort based",
            "example":"n,y"
        },
        "firstAssctdRandDesignSrcId":{
            "type":"string",
            "description":"Unique Id for the first associated randomization design.",
            "format":"uuid"
        },
        "firstAssctdStudyVersion":{
            "type":"string",
            "description":"Version of the first associated study",
            "format":"UUID",
            "example":"1.0.1"
        }
    },
    "description":"Contains randomization list details."
}

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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."
}

Show Source

• details: string
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

  Example: User role is missing required permission REPORTING_VIEW. Field: userId
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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."
}

Show Source

• details: string
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

  Example: User role is missing required permission REPORTING_VIEW. Field: userId
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}