Jump to

• Request
• Response

[Deprecated]: v1.0

get

/ec-codelist-svc/rest/v1.0/codelist

Deprecated: Use /v4.0/codelist instead. The v4 endpoint adds group scoping, study scoping, sorting, code-name search, and internal permission-skip support.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : Code

Type: object

Show Source

• canAddValues: boolean
  Whether values can be added.

  Example: true
• canHideValues: boolean
  Whether values can be hidden.

  Example: true
• codeGroupId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the codelist group.

  Example: B1B8327AFAA6412287106192AB5984EF
• codeLevel: string
  Minimum Length: 1

  Maximum Length: 32

  Codelist code level.

  Example: SYSTEM
• codeName: string
  Minimum Length: 1

  Maximum Length: 255

  Codelist code name.

  Example: AE_SEVERITY
• codeType: string
  Minimum Length: 1

  Maximum Length: 255

  Codelist code type.

  Example: SYSTEM
• comment: string
  Comment.

  Example: Updated description
• customizable: boolean
  Whether this code is customizable.

  Example: false
• description: string
  Minimum Length: 1

  Maximum Length: 4000

  Codelist description.

  Example: Severity of adverse event.
• displayCodeName: string
  Display name for the codelist.

  Example: AE Severity
• id: string
  Required. Study identifier used to scope the codelist request. Use a UUID represented as a 32-character uppercase hexadecimal string.

  Example: B1B8327AFAA6412287106192AB5984EF
• objectVersionNumber: number
  Object version number.

  Example: 1
• operationType: string
  Minimum Length: 1

  Maximum Length: 16

  Operation type.

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

  Example: 2026-03-03T17:50:51.48Z
• parCodeName: string
  Minimum Length: 1

  Maximum Length: 255

  Parent codelist code name.

  Example: AE
• reason: string
  Reason for change.

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

  Example: 1
• tag: string
  Minimum Length: 1

  Maximum Length: 32767

  Tag for the codelist.

  Example: safety
• tenantLevelOnly: boolean
  Whether this codelist is tenant-level only.

  Example: false
• userId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the user.

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

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

  Example: 2026-03-03T12:20:51.409Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Required. Study identifier used to scope the codelist request. Use a UUID represented as a 32-character uppercase hexadecimal string.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start timestamp.",
            "format":"date-time",
            "example":"2026-03-03T12:20:51.409Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end timestamp.",
            "format":"date-time",
            "example":"3099-12-31T00:00:00Z"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation type.",
            "example":"CREATED"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number.",
            "example":1
        },
        "optlock":{
            "type":"string",
            "description":"Optimistic lock timestamp.",
            "format":"date-time",
            "example":"2026-03-03T17:50:51.48Z"
        },
        "userId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the user.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "reason":{
            "type":"string",
            "description":"Reason for change.",
            "example":"Updating codelist"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Updated description"
        },
        "codeName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Codelist code name.",
            "example":"AE_SEVERITY"
        },
        "codeType":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Codelist code type.",
            "example":"SYSTEM"
        },
        "codeLevel":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Codelist code level.",
            "example":"SYSTEM"
        },
        "parCodeName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Parent codelist code name.",
            "example":"AE"
        },
        "description":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Codelist description.",
            "example":"Severity of adverse event."
        },
        "tag":{
            "maxLength":32767,
            "minLength":1,
            "type":"string",
            "description":"Tag for the codelist.",
            "example":"safety"
        },
        "codeGroupId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the codelist group.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "displayCodeName":{
            "type":"string",
            "description":"Display name for the codelist.",
            "example":"AE Severity"
        },
        "canAddValues":{
            "type":"boolean",
            "description":"Whether values can be added.",
            "example":true
        },
        "canHideValues":{
            "type":"boolean",
            "description":"Whether values can be hidden.",
            "example":true
        },
        "customizable":{
            "type":"boolean",
            "description":"Whether this code is customizable.",
            "example":false
        },
        "tenantLevelOnly":{
            "type":"boolean",
            "description":"Whether this codelist is tenant-level only.",
            "example":false
        }
    }
}

Examples

Select an example GetAllCodesV1DeprecatedResponse

400 Response

Invalid request URL.

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