REST API for Clinical One Cloud Service

~~[Deprecated]: v1.0~~

post

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

Deprecated: Use /v5.0/codelist/code instead. The v5 endpoint supports dynamic study codelists with mode-to-site mappings.

Request

Query Parameters

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
```

Supported Media Types

application/json

Root Schema : CodeListRequestV1.0

Type: object

Title: CodeListRequestV1.0

Codelist request payload containing the codelist definition and values.

Show Source

code: object CodeV1

Codelist definition.
values: array values

Codelist values.

{
    "title":"CodeListRequestV1.0",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/components/schemas/CodeV1"
        },
        "values":{
            "type":"array",
            "description":"Codelist values.",
            "example":[
                {
                    "codeValue":"MILD",
                    "codeLabel":"Mild",
                    "sequence":1,
                    "locale":"en"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/CodeValueV1"
            }
        }
    },
    "description":"Codelist request payload containing the codelist definition and values."
}

Nested Schema : CodeV1

Type: object

Codelist definition.

Show Source

codeLevel: string

Codelist code level.

Example: SYSTEM
codeName: string

Codelist code name.

Example: AE_SEVERITY
codeType: string

Codelist code type.

Example: String
comment: string

Comment.

Example: Updated description
description: string

Codelist description.

Example: Severity of adverse event.
id: string (uuid)

Unique identifier.
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
parCodeName: string

Parent codelist code name.

Example: AE
reason: string

Reason for change.

Example: Updating codelist
softwareVersionNumber: number

Software version number.

Example: 1
userId: string (uuid)

User unique identifier.
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":{
        "id":{
            "type":"string",
            "description":"Unique identifier.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start timestamp.",
            "format":"date-time",
            "example":"2026-03-05T06:56:01.013Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end timestamp.",
            "format":"date-time",
            "example":"3099-12-31T00:00:00Z"
        },
        "operationType":{
            "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-05T12:26:01.086Z"
        },
        "userId":{
            "type":"string",
            "description":"User unique identifier.",
            "format":"uuid"
        },
        "reason":{
            "type":"string",
            "description":"Reason for change.",
            "example":"Updating codelist"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Updated description"
        },
        "codeName":{
            "type":"string",
            "description":"Codelist code name.",
            "example":"AE_SEVERITY"
        },
        "description":{
            "type":"string",
            "description":"Codelist description.",
            "example":"Severity of adverse event."
        },
        "codeType":{
            "type":"string",
            "description":"Codelist code type.",
            "example":"String"
        },
        "codeLevel":{
            "type":"string",
            "description":"Codelist code level.",
            "example":"SYSTEM"
        },
        "parCodeName":{
            "type":"string",
            "description":"Parent codelist code name.",
            "example":"AE"
        }
    },
    "description":"Codelist definition.",
    "example":{
        "codeName":"AE_SEVERITY",
        "codeType":"SYSTEM",
        "codeLevel":"SYSTEM",
        "description":"Severity of adverse event."
    }
}

Example:

{
    "codeName":"AE_SEVERITY",
    "codeType":"SYSTEM",
    "codeLevel":"SYSTEM",
    "description":"Severity of adverse event."
}

Nested Schema : values

Type: array

Codelist values.

Show Source

Array of: object CodeValueV1

Codelist tag values.

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

Example:

[
    {
        "codeValue":"MILD",
        "codeLabel":"Mild",
        "sequence":1,
        "locale":"en"
    }
]

Nested Schema : CodeValueV1

Type: object

Codelist tag values.

Show Source

code: string

Codelist value code.

Example: MILD
codeId: string (uuid)

Parent codelist unique identifier.
codeLabel: string

Codelist value label.

Example: Mild
codeValue: string

Codelist value.

Example: MILD
comment: string

Comment.

Example: Updated description
id: string (uuid)

Unique identifier.
locale: string

Locale.

Example: en-US
objectVersionNumber: number

Object version number.

Example: 1
operationType: string

Operation type.

Example: CREATED
optLock: string (date-time)
reason: string

Reason for change.

Example: Updating codelist value
sequence: number

Display sequence.

Example: 1
softwareVersionNumber: number

Software version number.

Example: 1
userId: string (uuid)

User unique identifier.
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":{
        "id":{
            "type":"string",
            "description":"Unique identifier.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start timestamp.",
            "format":"date-time",
            "example":"2026-03-05T06:56:01.013Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end timestamp.",
            "format":"date-time",
            "example":"3099-12-31T00:00:00Z"
        },
        "operationType":{
            "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
        },
        "userId":{
            "type":"string",
            "description":"User unique identifier.",
            "format":"uuid"
        },
        "reason":{
            "type":"string",
            "description":"Reason for change.",
            "example":"Updating codelist value"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Updated description"
        },
        "codeId":{
            "type":"string",
            "description":"Parent codelist unique identifier.",
            "format":"uuid"
        },
        "codeValue":{
            "type":"string",
            "description":"Codelist value.",
            "example":"MILD"
        },
        "codeLabel":{
            "type":"string",
            "description":"Codelist value label.",
            "example":"Mild"
        },
        "code":{
            "type":"string",
            "description":"Codelist value code.",
            "example":"MILD"
        },
        "sequence":{
            "type":"number",
            "description":"Display sequence.",
            "example":1
        },
        "locale":{
            "type":"string",
            "description":"Locale.",
            "example":"en-US"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        }
    },
    "description":"Codelist tag values.",
    "example":[
        {
            "id":"D1D8327AFAA6412287106192AB5984EF",
            "tag":"safety"
        }
    ]
}

Example:

[
    {
        "id":"D1D8327AFAA6412287106192AB5984EF",
        "tag":"safety"
    }
]

Examples

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : BaseCodeListDtoV1.0

Type: object

Title: BaseCodeListDtoV1.0

Codelist response payload containing the codelist definition and values.

Show Source

code: object code

Codelist definition.
values: array values

Codelist values.

{
    "title":"BaseCodeListDtoV1.0",
    "type":"object",
    "properties":{
        "code":{
            "type":"object",
            "description":"Codelist definition.",
            "example":{
                "id":"D1D8327AFAA6412287106192AB5984EF",
                "codeName":"AE_SEVERITY",
                "codeType":"String",
                "codeLevel":"SYSTEM"
            }
        },
        "values":{
            "type":"array",
            "description":"Codelist values.",
            "example":[
                {
                    "id":"56B7D39029424986ADC86DC4B976DD5E",
                    "codeValue":"MILD",
                    "codeLabel":"Mild",
                    "sequence":1,
                    "locale":"en-US"
                }
            ],
            "items":{
                "type":"object",
                "description":"Codelist values.",
                "example":[
                    {
                        "id":"56B7D39029424986ADC86DC4B976DD5E",
                        "codeValue":"MILD",
                        "codeLabel":"Mild",
                        "sequence":1,
                        "locale":"en-US"
                    }
                ]
            }
        }
    },
    "description":"Codelist response payload containing the codelist definition and values."
}

Nested Schema : code

Type: object

Codelist definition.

Example:

{
    "id":"D1D8327AFAA6412287106192AB5984EF",
    "codeName":"AE_SEVERITY",
    "codeType":"String",
    "codeLevel":"SYSTEM"
}

Nested Schema : values

Type: array

Codelist values.

Show Source

Array of: object items

Codelist values.

{
    "type":"array",
    "description":"Codelist values.",
    "example":[
        {
            "id":"56B7D39029424986ADC86DC4B976DD5E",
            "codeValue":"MILD",
            "codeLabel":"Mild",
            "sequence":1,
            "locale":"en-US"
        }
    ],
    "items":{
        "type":"object",
        "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"
    }
]

Nested Schema : items

Type: object

Codelist values.

Example:

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

Examples

400 Response

'Missing required code definition', 'Missing required values definition','Missing required field (codeName)','Missing required field (codeType)','Duplicate code name', 'Internal server error'

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

500 Response

Internal server error

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