REST API for Clinical One Platform

~~[Deprecated]: Update code list with tags by code list ID~~

put

/ec-codelist-svc/rest/v1.0/codelist/code/{codeId}

Deprecated: Updates system-level specific code list based on the given payload and code list ID for the version v1.0. Version v2.0 includes tags information if present. Right: CodeListPost.

Request

Path Parameters

codeId(required): string

ID of the codelist (depending on 'type' parameter, id can be used as uuid, code name, or tag)

Query Parameters

mode(required): string

Mode of the study. Allowed values are active, test and training
studyId(required): string

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

code: object CodeV1
values: array values

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

Nested Schema : CodeV1

Type: object

Show Source

codeLevel: string
codeName: string
codeType: string
comment: string
description: string
id: string (uuid)
objectVersionNumber: number
operationType: string
optlock: string (date-time)
parCodeName: string
reason: string
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":{
            "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":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "codeType":{
            "type":"string"
        },
        "codeLevel":{
            "type":"string"
        },
        "parCodeName":{
            "type":"string"
        }
    }
}

Nested Schema : values

Type: array

Show Source

Array of: object CodeValueV1

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

Nested Schema : CodeValueV1

Type: object

Show Source

code: string
codeId: string (uuid)
codeLabel: string
codeValue: string
comment: string
id: string (uuid)
locale: string
objectVersionNumber: number
operationType: string
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":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "codeId":{
            "type":"string",
            "format":"uuid"
        },
        "codeValue":{
            "type":"string"
        },
        "codeLabel":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "sequence":{
            "type":"number"
        },
        "locale":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : BaseCodeListDto

Type: object

Show Source

code: object code
values: array values

{
    "type":"object",
    "properties":{
        "code":{
            "type":"object"
        },
        "values":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : code

Type: object

Nested Schema : values

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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

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.

500 Response

Internal server error

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.