Jump to

• Request
• Response

v2.0

get

/ec-codelist-svc/rest/v2.0/codelist/all

Get all codelist values for the requested scope (tenant or study) and optional filters.

Request

Query Parameters

• allFields: boolean
  Indicates whether hidden fields need to be retrieved. Allowed values are true or false.

  Example:

  true

• codelistType: string
  Type of the codelist. Allowed values are USER, CUSTOM, SYSTEM, APPLICATION.

  Example:

  SYSTEM

• mode(required): string
  Mode of the study. Allowed values are active, test and training

  Example:

  DESIGN

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string)

  Example:

  B1B8327AFAA6412287106192AB5984EF

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object BaseCodeListDto

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

Nested Schema : BaseCodeListDto

Type: object

Show Source

• code: object code
• values: array values

{
    "type":"object",
    "properties":{
        "code":{
            "type":"object"
        },
        "values":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : code

Type: object

Nested Schema : values

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Examples

Select an example GetAllCodelistsV2Response

400 Response

Invalid request URL.

Body ()

Root Schema : CodeListResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object

Back to Top