REST API for Clinical One Platform

Get all code lists matching a given study ID, code ID and language

get

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

Retrieves a list of all the code list values matching the given study ID, code ID and language.

Request

Query Parameters

codeId: string

ID of the Code
language: string

Language for expected response codelist. This overrides user preference for language. This field is case sensitive and accepts values like en, ja etc. By default it's english (en)
limit(required): integer(int32)

Minimum Value: 1

limit.
offset(required): integer(int32)

Minimum Value: 0

offset.
studyId: string

ID of the study

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : CodeValueV4

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
loinc: 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"
        },
        "loinc":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        }
    }
}