Show Source

• cohortId: string (uuid)
  Cohort ID
• enabled: boolean
  Indicates if cohort is enabled.

  Example: true
• enrollmentLimitReached: boolean
  Indicate if enrollment limit is reached.

  Example: true
• notificationLimit: number (double)
  Notification limit value. Once value is reached a notification is sent.

  Example: 5
• randomizationLimit: number (double)
  Maximum number of subjects who can be randomized for the study.

  Example: 5
• randomizedSubjects: number (double)
  Number of randomized subjects

  Example: 5

{
    "type":"object",
    "properties":{
        "cohortId":{
            "type":"string",
            "description":"Cohort ID",
            "format":"uuid"
        },
        "randomizationLimit":{
            "type":"number",
            "description":"Maximum number of subjects who can be randomized for the study.",
            "format":"double",
            "example":5
        },
        "notificationLimit":{
            "type":"number",
            "description":"Notification limit value. Once value is reached a notification is sent.",
            "format":"double",
            "example":5
        },
        "randomizedSubjects":{
            "type":"number",
            "description":"Number of randomized subjects",
            "format":"double",
            "example":5
        },
        "enabled":{
            "type":"boolean",
            "description":"Indicates if cohort is enabled.",
            "example":true
        },
        "enrollmentLimitReached":{
            "type":"boolean",
            "description":"Indicate if enrollment limit is reached.",
            "example":true
        }
    },
    "description":"Response object containing cohort enrollment 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."
}