Jump to

• Request
• Response

v2.0

put

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

Saves cohort limits by study and mode. Rights: SubjectSettingRightsPost.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Query Parameters

• fromMode: string
  From mode.

  Example:

  test

Supported Media Types

• */*

Request Body - */* ()

Root Schema : CohortLimitList

Type: object

Title: CohortLimitList

Contains list of cohort limits.

Show Source

• cohortLimits(required): array cohortLimits
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

{
    "title":"CohortLimitList",
    "required":[
        "cohortLimits"
    ],
    "type":"object",
    "properties":{
        "cohortLimits":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CohortLimitV3"
            }
        }
    },
    "description":"Contains list of cohort limits."
}

Nested Schema : cohortLimits

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

• Array of: object CohortLimit v3.0
  Title: CohortLimit v3.0

  Response object containing cohort limit details.

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CohortLimitV3"
    }
}

Nested Schema : CohortLimit v3.0

Type: object

Title: CohortLimit v3.0

Response object containing cohort limit details.

Show Source

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

  Example: true
• forcedRandLimit: number (Integer)
  Minimum Value: 1

  Maximum Value: 999999

  Forced Randomization limit value.

  Example: 5
• 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
• stratumId: string (uuid)
  Stratum ID.

{
    "title":"CohortLimit v3.0",
    "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
        },
        "stratumId":{
            "type":"string",
            "description":"Stratum ID.",
            "format":"uuid"
        },
        "forcedRandLimit":{
            "maximum":999999,
            "minimum":1,
            "type":"number",
            "description":"Forced Randomization limit value.",
            "format":"Integer",
            "example":5
        }
    },
    "description":"Response object containing cohort limit details."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Cohort Limit v2.0
  Title: Cohort Limit v2.0

  Response object containing cohort limit details.

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

Nested Schema : Cohort Limit v2.0

Type: object

Title: Cohort Limit v2.0

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
• stratumId: string (uuid)
  Stratum ID.

{
    "title":"Cohort Limit v2.0",
    "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
        },
        "stratumId":{
            "type":"string",
            "description":"Stratum ID.",
            "format":"uuid"
        }
    },
    "description":"Response object containing cohort limit details.",
    "example":{
        "cohortId":"B1B8327AFAA6412287106192AB5984EF",
        "stratumId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "randomizationLimit":100,
        "notificationLimit":80,
        "enabled":true
    }
}

Example:

{
    "cohortId":"B1B8327AFAA6412287106192AB5984EF",
    "stratumId":"C36A3197FDEE433FB5547EE83DE99E4B",
    "randomizationLimit":100,
    "notificationLimit":80,
    "enabled":true
}

Examples

Select an example Set Cohort Limits Response

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

Examples

Select an example Server Error

Back to Top