Jump to

• Request
• Response

v3.0

get

/ec-codelist-svc/rest/v3.0/codelist/{name}

Get the values for a single codelist using its name.

Request

Path Parameters

• name(required): string
  Required. Codelist name.

  Example:

  AESEV

Query Parameters

• dataType: string
  Optional. Data type to return. Allowed values are current and history. Default is current.

  Example:

  current

• mode(required): string
  Required. Study mode used to scope the codelist request. Allowed values are active, test, and training.

  Example:

  test

• studyId(required): string
  Required. Study identifier used to scope the codelist request. Use a UUID represented as a 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 : CodeListDto

Type: object

Show Source

• codeName: string
  Codelist code name.

  Example: AE_SEVERITY
• codeType: string
  Codelist code type.

  Example: String
• comment: string
  Comment.

  Example: Updated description
• id: string
  Codelist unique identifier.

  Example: D1D8327AFAA6412287106192AB5984EF
• objectVersionNumber: number
  Object version number.

  Example: 1
• operationType: string
  Operation type.

  Example: CREATED
• optLock: string (date-time)
  Optimistic lock timestamp.

  Example: 2026-03-05T12:26:01.086Z
• reason: string
  Reason for change.

  Example: Updating codelist
• softwareVersionNumber: number
  Software version number.

  Example: 1
• userId: string
  User unique identifier.

  Example: 0000000000000000000000000000000A
• values: array values
  Codelist values.
• versionEnd: string (date-time)
  Version end timestamp.

  Example: 3099-12-31T00:00:00Z
• versionStart: string (date-time)
  Version start timestamp.

  Example: 2026-03-05T06:56:01.013Z

{
    "type":"object",
    "properties":{
        "codeName":{
            "type":"string",
            "description":"Codelist code name.",
            "example":"AE_SEVERITY"
        },
        "codeType":{
            "type":"string",
            "description":"Codelist code type.",
            "example":"String"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Updated description"
        },
        "id":{
            "type":"string",
            "description":"Codelist unique identifier.",
            "example":"D1D8327AFAA6412287106192AB5984EF"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "example":1
        },
        "operationType":{
            "type":"string",
            "description":"Operation type.",
            "example":"CREATED"
        },
        "optLock":{
            "type":"string",
            "description":"Optimistic lock timestamp.",
            "format":"date-time",
            "example":"2026-03-05T12:26:01.086Z"
        },
        "reason":{
            "type":"string",
            "description":"Reason for change.",
            "writeOnly":true,
            "example":"Updating codelist"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number.",
            "example":1
        },
        "userId":{
            "type":"string",
            "description":"User unique identifier.",
            "example":"0000000000000000000000000000000A"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end timestamp.",
            "format":"date-time",
            "example":"3099-12-31T00:00:00Z"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start timestamp.",
            "format":"date-time",
            "example":"2026-03-05T06:56:01.013Z"
        },
        "values":{
            "type":"array",
            "description":"Codelist values.",
            "example":[
                {
                    "id":"56B7D39029424986ADC86DC4B976DD5E",
                    "codeValue":"MILD",
                    "codeLabel":"Mild",
                    "sequence":1,
                    "locale":"en-US"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/CodeValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Codelist values.

Show Source

• Array of: object CodeValueDto
  Codelist values.

{
    "type":"array",
    "description":"Codelist values.",
    "example":[
        {
            "id":"56B7D39029424986ADC86DC4B976DD5E",
            "codeValue":"MILD",
            "codeLabel":"Mild",
            "sequence":1,
            "locale":"en-US"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/CodeValueDto"
    }
}

Example:

[
    {
        "id":"56B7D39029424986ADC86DC4B976DD5E",
        "codeValue":"MILD",
        "codeLabel":"Mild",
        "sequence":1,
        "locale":"en-US"
    }
]

Nested Schema : CodeValueDto

Type: object

Codelist values.

Show Source

• codeId: string
  Parent codelist unique identifier.

  Example: 6B0BE74E22864269898DCD7F2E55A130
• codeLabel: string
  Codelist value label.

  Example: Mild
• codeValue: string
  Codelist value.

  Example: MILD
• comment: string
  Comment.

  Example: Updated label
• id: string
  Codelist value unique identifier.

  Example: 56B7D39029424986ADC86DC4B976DD5E
• locale: string
  Locale.

  Example: en-US
• objectVersionNumber: number
  Object version number.

  Example: 1
• operationType: string
  Operation type.

  Example: CREATED
• optLock: string (date-time)
  Optimistic lock timestamp.

  Example: 2026-03-05T12:26:01.086Z
• reason: string
  Reason for change.

  Example: Updating codelist value
• softwareVersionNumber: number
  Software version number.

  Example: 1
• userId: string
  User unique identifier.

  Example: 0000000000000000000000000000000A
• versionEnd: string (date-time)
  Version end timestamp.

  Example: 3099-12-31T00:00:00Z
• versionStart: string (date-time)
  Version start timestamp.

  Example: 2026-03-05T06:56:01.013Z

{
    "type":"object",
    "properties":{
        "codeId":{
            "type":"string",
            "description":"Parent codelist unique identifier.",
            "example":"6B0BE74E22864269898DCD7F2E55A130"
        },
        "codeLabel":{
            "type":"string",
            "description":"Codelist value label.",
            "example":"Mild"
        },
        "codeValue":{
            "type":"string",
            "description":"Codelist value.",
            "example":"MILD"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Updated label"
        },
        "id":{
            "type":"string",
            "description":"Codelist value unique identifier.",
            "example":"56B7D39029424986ADC86DC4B976DD5E"
        },
        "locale":{
            "type":"string",
            "description":"Locale.",
            "example":"en-US"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "example":1
        },
        "operationType":{
            "type":"string",
            "description":"Operation type.",
            "example":"CREATED"
        },
        "optLock":{
            "type":"string",
            "description":"Optimistic lock timestamp.",
            "format":"date-time",
            "example":"2026-03-05T12:26:01.086Z"
        },
        "reason":{
            "type":"string",
            "description":"Reason for change.",
            "writeOnly":true,
            "example":"Updating codelist value"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number.",
            "example":1
        },
        "userId":{
            "type":"string",
            "description":"User unique identifier.",
            "example":"0000000000000000000000000000000A"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end timestamp.",
            "format":"date-time",
            "example":"3099-12-31T00:00:00Z"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start timestamp.",
            "format":"date-time",
            "example":"2026-03-05T06:56:01.013Z"
        }
    },
    "description":"Codelist values.",
    "example":[
        {
            "id":"56B7D39029424986ADC86DC4B976DD5E",
            "codeValue":"MILD",
            "codeLabel":"Mild",
            "sequence":1,
            "locale":"en-US"
        }
    ]
}

Example:

[
    {
        "id":"56B7D39029424986ADC86DC4B976DD5E",
        "codeValue":"MILD",
        "codeLabel":"Mild",
        "sequence":1,
        "locale":"en-US"
    }
]

Examples

Select an example GetCodelistByNameV3Response

400 Response

'Internal server error', 'Invalid version number','Missing required field (codeName)'

Body ()

Root Schema : CodeListResponseV1.0

Type: object

Title: CodeListResponseV1.0

Standard codelist service response envelope.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Response result.
• status: string
  Response status.

  Example: success

{
    "title":"CodeListResponseV1.0",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Response result.",
            "example":{
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Standard codelist service response envelope."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Response result.

Example:

{
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example BadRequestResponse

500 Response

Internal server error

Body ()

Root Schema : CodeListResponseV1.0

Type: object

Title: CodeListResponseV1.0

Standard codelist service response envelope.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Response result.
• status: string
  Response status.

  Example: success

{
    "title":"CodeListResponseV1.0",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Response result.",
            "example":{
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Standard codelist service response envelope."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Response result.

Example:

{
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example ServerErrorResponse

Back to Top