Jump to

• Request
• Response

V1.0

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/cohorts

Retrieves a list of all cohorts in a study. You can retrieve this list by study ID.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• mode(required): string
  Study version mode to filter cohorts.

  Allowed Values: [ "test", "training", "active" ]

  Example:

  test

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 CohortDto v1.0
  Title: CohortDto v1.0

  Randomization Cohort Details Information

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

Nested Schema : CohortDto v1.0

Type: object

Title: CohortDto v1.0

Randomization Cohort Details Information

Show Source

• factors: array factors
• id: string (uuid)
  Cohort Unique GUID
• name(required): string
  Minimum Length: 1

  Maximum Length: 64

  Cohort Name

  Example: Cohort Demography Group 1
• type(required): string
  Allowed Values: [ "None", "Adaptive", "Demography" ]

  Cohort Type

  Example: Demography

{
    "title":"CohortDto v1.0",
    "required":[
        "name",
        "type"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Cohort Unique GUID",
            "format":"uuid"
        },
        "name":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Cohort Name",
            "example":"Cohort Demography Group 1"
        },
        "type":{
            "type":"string",
            "description":"Cohort Type",
            "example":"Demography",
            "enum":[
                "None",
                "Adaptive",
                "Demography"
            ]
        },
        "factors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CohortFactorDtoV1"
            }
        }
    },
    "description":"Randomization Cohort Details Information"
}

Nested Schema : factors

Type: array

Show Source

• Array of: object CohortFactorDto v1.0
  Title: CohortFactorDto v1.0

  Discriminator: { "propertyName":"type", "mapping":{ "choice":"#/components/schemas/CohortChoiceFactorDtoV2", "range":"#/components/schemas/CohortRangeFactorDtoV2" } }

  Randomization Cohort Factor Information

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

Nested Schema : CohortFactorDto v1.0

Type: object

Title: CohortFactorDto v1.0

Discriminator: type

Discriminator Values

• choice
• range

{
    "title":"CohortFactorDto v1.0",
    "required":[
        "formId",
        "itemId",
        "type"
    ],
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Item GUID",
            "format":"uuid"
        },
        "type":{
            "type":"string"
        }
    },
    "description":"Randomization Cohort Factor Information",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "choice":"#/components/schemas/CohortChoiceFactorDtoV2",
            "range":"#/components/schemas/CohortRangeFactorDtoV2"
        }
    },
    "anyOf":[
        {
            "$ref":"#/components/schemas/CohortChoiceFactorDtoV2"
        },
        {
            "$ref":"#/components/schemas/CohortRangeFactorDtoV2"
        }
    ]
}

Randomization Cohort Factor Information

Show Source

• formId(required): string (uuid)
  Form GUID
• itemId(required): string (uuid)
  Item GUID
• type(required): string

{
    "title":"CohortFactorDto v1.0",
    "required":[
        "formId",
        "itemId",
        "type"
    ],
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Item GUID",
            "format":"uuid"
        },
        "type":{
            "type":"string"
        }
    },
    "description":"Randomization Cohort Factor Information",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "choice":"#/components/schemas/CohortChoiceFactorDtoV2",
            "range":"#/components/schemas/CohortRangeFactorDtoV2"
        }
    },
    "anyOf":[
        {
            "$ref":"#/components/schemas/CohortChoiceFactorDtoV2"
        },
        {
            "$ref":"#/components/schemas/CohortRangeFactorDtoV2"
        }
    ]
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root 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 : details

Type: object

Back to Top