Jump to

• Request
• Response

Get cohort limits by study and mode

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings/cohortlimits

Retrieves cohort limits by study and mode. Rights: SubjectSettingRightsGet.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of 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 : schema

Type: array

Show Source

• Array of: object CohortLimit
  Response object containing cohort limit details.

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

Nested Schema : CohortLimit

Type: object

Response object containing cohort limit details.

Show Source

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

  Example: true
• notificationLimit: number (double)
  Minimum Value: 1

  Maximum Value: 100

  Notification limit value. Once value is reached a notification is sent.

  Example: 5
• randomizationLimit: number (double)
  Minimum Value: 1

  Maximum number of subjects who can be randomized for the study.

  Example: 5

{
    "required":[
        "cohortId",
        "enabled"
    ],
    "type":"object",
    "properties":{
        "cohortId":{
            "type":"string",
            "description":"Cohort ID",
            "format":"uuid"
        },
        "randomizationLimit":{
            "minimum":"1",
            "type":"number",
            "description":"Maximum number of subjects who can be randomized for the study.",
            "format":"double",
            "example":"5"
        },
        "notificationLimit":{
            "maximum":"100",
            "minimum":"1",
            "type":"number",
            "description":"Notification limit value. Once value is reached a notification is sent.",
            "format":"double",
            "example":"5"
        },
        "enabled":{
            "type":"boolean",
            "description":"Indicates if cohort is enabled.",
            "example":true
        }
    },
    "description":"Response object containing cohort limit details."
}

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