Show Source

• treatmentArms: array treatmentArms

{
    "title":"UnblindedRandomizationHistoryDTO v2.0",
    "type":"object",
    "properties":{
        "treatmentArms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandomizationDetailsDTOV2"
            }
        }
    },
    "description":"Contains unblinded randomization history."
}

Show Source

• Array of: object RandomizationDetailsDTO v2.0
  Title: RandomizationDetailsDTO v2.0

  Contains randomization details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RandomizationDetailsDTOV2"
    }
}

Show Source

• cohortId: string (uuid)
  ID of the cohort
• description: string
  Randomization description

  Example: RndA
• externalTreatmentId: string
  External Treatment Id.

  Example: B1B8327AFAA6412287106192AB5984EF
• id: string (uuid)
  Randomization Id.
• randNumber: number (double)
  Randomization number.

  Example: 5
• randomizationDate: string (date-time)
  Randomization date
• rndStatusId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5 ]

  Unique ID corresponding to each Randomization status value (1 for Not Approved, 2 for Available, 3 for Not Released, 4 for Assigned, 5 for Randomized in Error).

  Example: 1
• visitId: string (uuid)
  ID of the visit

{
    "title":"RandomizationDetailsDTO v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Randomization Id.",
            "format":"uuid"
        },
        "randNumber":{
            "type":"number",
            "description":"Randomization number.",
            "format":"double",
            "example":5
        },
        "randomizationDate":{
            "type":"string",
            "description":"Randomization date",
            "format":"date-time"
        },
        "rndStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each Randomization status value (1 for Not Approved, 2 for Available, 3 for Not Released, 4 for Assigned, 5 for Randomized in Error).",
            "format":"double",
            "example":1,
            "enum":[
                1,
                2,
                3,
                4,
                5
            ]
        },
        "description":{
            "type":"string",
            "description":"Randomization description",
            "example":"RndA"
        },
        "externalTreatmentId":{
            "type":"string",
            "description":"External Treatment Id.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "visitId":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        },
        "cohortId":{
            "type":"string",
            "description":"ID of the cohort",
            "format":"uuid"
        }
    },
    "description":"Contains randomization 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."
}