REST API for Clinical One Platform

Get a list of all code lists by code list type

get

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

Retrieves a list of all code lists by code list type. To retrieve code lists for a particular Group, groupId param must be passed.

Request

Query Parameters

codeName: string

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

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

Allowed Values: [ "USER", "CUSTOM", "SYSTEM", "APPLICATION" ]
groupId: string(uuid)

Id of a CodeList group. When specified, returns codelists of the group (including non-customized SYSTEM default codelists)
mode: string

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

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

Default Value: codeName:asc
studyId: string(uuid)

ID of the study

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : Code

Type: object

Show Source

canAddValues: boolean
canHideValues: boolean
codeGroupId: string (uuid)
codeLevel: string

Minimum Length: 1

Maximum Length: 32
codeName: string

Minimum Length: 1

Maximum Length: 255
codeType: string

Minimum Length: 1

Maximum Length: 255
comment: string
customizable: boolean
description: string

Minimum Length: 1

Maximum Length: 4000
displayCodeName: string
id: string (uuid)
objectVersionNumber: number
operationType: string

Minimum Length: 1

Maximum Length: 16
optlock: string (date-time)
parCodeName: string

Minimum Length: 1

Maximum Length: 255
reason: string
softwareVersionNumber: number
tag: string

Minimum Length: 1

Maximum Length: 32767
tenantLevelOnly: boolean
userId: string (uuid)
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "optlock":{
            "type":"string",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "codeName":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "codeType":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "codeLevel":{
            "maxLength":32,
            "minLength":1,
            "type":"string"
        },
        "parCodeName":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "description":{
            "maxLength":4000,
            "minLength":1,
            "type":"string"
        },
        "tag":{
            "maxLength":32767,
            "minLength":1,
            "type":"string"
        },
        "codeGroupId":{
            "type":"string",
            "format":"uuid"
        },
        "displayCodeName":{
            "type":"string"
        },
        "canAddValues":{
            "type":"boolean"
        },
        "canHideValues":{
            "type":"boolean"
        },
        "customizable":{
            "type":"boolean"
        },
        "tenantLevelOnly":{
            "type":"boolean"
        }
    }
}

400 Response

Invalid request URL.

Root Schema : CodeListResponse

Type: object

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result
status: string

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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.