REST API for Clinical One Platform

~~[Deprecated]: Get code list matching the given parameters~~

get

/ec-codelist-svc/rest/v2.0/codelist/values/{fieldName}

Deprecated: Retrieves the list of all code lists values matching the given fieldName, type, studyId, groupId, data type, isHierarchial and language passed.

Request

Path Parameters

fieldName(required): string

Name of the fields. It can be code name, tag name or code id.

Query Parameters

allFields: boolean

Indicates whether hidden fields need to be retrieved. Allowed values are true or false.
dataType: string

Data Type. Allowed values are current, history. Default is current.

Allowed Values: [ "current", "history" ]
groupId: string(uuid)

ID of the group
includeHidden: boolean

Indicates whether hidden code values should be returned. Allowed values are true or false. Default is false

Default Value: true
isHierarchial: boolean

Indicates whether hierarchial code values need to be retrieved. Allowed values are true or false.
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)
mode: string

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

ID of the study
type: string

Field Type. Allowed values are code, tag and id. Default is code.

Allowed Values: [ "code", "tag", "id" ]

There's no request body for this operation.

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 field (codeName).

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