REST API for Clinical One Platform

~~[Deprecated]: Insert a new code list~~

post

/ec-codelist-svc/rest/v2.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
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"
        },
        "tenantLevelOnly":{
            "type":"boolean"
        },
        "customizable":{
            "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
codeGroupId: string (uuid)
codeId: string (uuid)
codeLabel: string

Minimum Length: 1

Maximum Length: 32767
codeValue: string

Minimum Length: 1

Maximum Length: 32767
comment: string
customizationType: string
hidden: boolean
id: string (uuid)
language: string

Minimum Length: 1

Maximum Length: 10
locale: string

Minimum Length: 1

Maximum Length: 255
loinc: string
objectVersionNumber: number
operationType: string

Minimum Length: 1

Maximum Length: 16
optlock: string (date-time)
reason: string
sequence: number
softwareVersionNumber: number
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"
        },
        "codeId":{
            "type":"string",
            "format":"uuid"
        },
        "locale":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "codeValue":{
            "maxLength":32767,
            "minLength":1,
            "type":"string"
        },
        "codeLabel":{
            "maxLength":32767,
            "minLength":1,
            "type":"string"
        },
        "code":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "sequence":{
            "type":"number"
        },
        "language":{
            "maxLength":10,
            "minLength":1,
            "type":"string"
        },
        "codeGroupId":{
            "type":"string",
            "format":"uuid"
        },
        "hidden":{
            "type":"boolean"
        },
        "customizationType":{
            "type":"string"
        },
        "loinc":{
            "type":"string"
        }
    }
}

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

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 : CodeListResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result
status: string

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

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object