REST API for Clinical One Cloud Service

~~[Deprecated]: v1.0~~

post

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

Deprecated: This method is no longer used to insert a new system-level code list based on the given payload. The API used to insert code lists at a user-level will be provided in the future.
Right: CodeListPost.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

code: object Code
values: array values

{
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/components/schemas/Code"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeValue"
            }
        }
    }
}

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"
        }
    }
}

Nested Schema : values

Type: array

Show Source

Array of: object CodeValue

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

Nested Schema : CodeValue

Type: object

Show Source

code: string

Minimum Length: 1

Maximum Length: 255

Codelist value code (legacy).

Example: MILD
codeGroupId: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the codelist group.

Example: B1B8327AFAA6412287106192AB5984EF
codeId: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the parent codelist code.

Example: B1B8327AFAA6412287106192AB5984EF
codeLabel: string

Minimum Length: 1

Maximum Length: 32767

Codelist value label.

Example: Mild
codeValue: string

Minimum Length: 1

Maximum Length: 32767

Codelist value.

Example: MILD
comment: string

Comment.

Example: Updated label
customizationType: string

Customization type.

Example: CUSTOM
hidden: boolean

Whether the value is hidden.

Example: false
id: string

Unique identifier (UUID, 32-character uppercase hexadecimal string)

Example: B1B8327AFAA6412287106192AB5984EF
language: string

Minimum Length: 1

Maximum Length: 10

Language code.

Example: en
locale: string

Minimum Length: 1

Maximum Length: 255

Locale code.

Example: en
loinc: string

LOINC code.

Example: 1234-5
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.
reason: string

Reason for change.

Example: Updating codelist values
sequence: number

Display sequence.

Example: 1
softwareVersionNumber: number

Software version number.

Example: 1
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 values"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Updated label"
        },
        "codeId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the parent codelist code.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "locale":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Locale code.",
            "example":"en"
        },
        "codeValue":{
            "maxLength":32767,
            "minLength":1,
            "type":"string",
            "description":"Codelist value.",
            "example":"MILD"
        },
        "codeLabel":{
            "maxLength":32767,
            "minLength":1,
            "type":"string",
            "description":"Codelist value label.",
            "example":"Mild"
        },
        "code":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Codelist value code (legacy).",
            "example":"MILD"
        },
        "sequence":{
            "type":"number",
            "description":"Display sequence.",
            "example":1
        },
        "language":{
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"Language code.",
            "example":"en"
        },
        "codeGroupId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the codelist group.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "hidden":{
            "type":"boolean",
            "description":"Whether the value is hidden.",
            "example":false
        },
        "customizationType":{
            "type":"string",
            "description":"Customization type.",
            "example":"CUSTOM"
        },
        "loinc":{
            "type":"string",
            "description":"LOINC code.",
            "example":"1234-5"
        }
    }
}

Examples

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : CodeListDto

Type: object

Show Source

codeName: string
codeType: string
comment: string
id: string (uuid)
objectVersionNumber: number
operationType: string
optLock: string (date-time)
reason: string
softwareVersionNumber: number
userId: string (uuid)
values: array values
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "codeName":{
            "type":"string"
        },
        "codeType":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string",
            "writeOnly":true
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

Array of: object CodeValueDto

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

Nested Schema : CodeValueDto

Type: object

Show Source

codeId: string (uuid)
codeLabel: string
codeValue: string
comment: string
id: string (uuid)
locale: string
objectVersionNumber: number
operationType: string
optLock: string (date-time)
reason: string
softwareVersionNumber: number
userId: string (uuid)
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "codeId":{
            "type":"string",
            "format":"uuid"
        },
        "codeLabel":{
            "type":"string"
        },
        "codeValue":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "locale":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string",
            "writeOnly":true
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Examples

400 Response

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

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

500 Response

Internal server error

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