REST API for Clinical One Platform

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

put

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

Deprecated: Updates system-level specific code list based on the given payload and GUID of the code list with tag information if present. Right: CodeListPost.

Request

Path Parameters

codeId(required): string(uuid)

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

Query Parameters

groupId: string(uuid)

ID of the group
mode: string

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

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

code: object CodeV3
values: array values

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

Nested Schema : CodeV3

Type: object

Show Source

canAddValues: boolean
canHideValues: boolean
codeGroupId: string (uuid)
codeLevel: string
codeName: string
codeType: string
comment: string
customizable: boolean
description: string
displayCodeName: string
id: string (uuid)
objectVersionNumber: number
operationType: string
optlock: string (date-time)
parCodeName: string
reason: string
softwareVersionNumber: number
studyId: string (uuid)
tag: string
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":{
            "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"
        },
        "tag":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "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 CodeValueV3

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

Nested Schema : CodeValueV3

Type: object

Show Source

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