REST API for Clinical One Cloud Service

v1.0

get

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

View historical changes to codelists for a given name and (optionally) study.

Request

Query Parameters

codeId: string
Unique identifier (UUID, 32-character uppercase hexadecimal string) of the code
Example:
```
B1B8327AFAA6412287106192AB5984EF
```
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)
Example:
```
en
```
limit(required): integer(int32)
Minimum Value: 1

limit.
Example:
```
50
```
offset(required): integer(int32)
Minimum Value: 0

offset.
Example:
```
0
```
studyId: string
Unique identifier (UUID, 32-character uppercase hexadecimal string)
Example:
```
B1B8327AFAA6412287106192AB5984EF
```

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

Examples