Jump to

• Request
• Response

v4.0

get

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

List available codelists. You can filter by type and optionally scope results to a study or a group.

Request

Query Parameters

• codeName: string
  codeName. Search codelists by a query (code name or a part of it). Case-Insensitive

  Example:

  AE

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

  Allowed Values: [ "USER", "CUSTOM", "SYSTEM", "APPLICATION", "DYNAMIC", "DESIGN" ]
• groupId: string(uuid)
  ID of a CodeList group. When specified, returns codelists of the group (including non-customized SYSTEM default codelists)

  Example:

  B1B8327AFAA6412287106192AB5984EF

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

  Example:

  DESIGN

• sortBy: string
  sortBy. By default list is sorted by name in alphabetical order

  Default Value: codeName:asc

  Example:

  displayCodeName:asc

• studyId: string(uuid)
  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 Code

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

Nested 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
• 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
  Unique identifier (UUID, 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.
• 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
• userId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the user.

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string)",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start timestamp.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end timestamp.",
            "format":"date-time"
        },
        "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"
        },
        "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"
        },
        "tenantLevelOnly":{
            "type":"boolean"
        }
    }
}

Examples

Select an example GetCodelistsV4Response

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