REST API for Clinical One Platform

~~[Deprecated]: Get all code list values by code list ID and data type~~

get

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

Deprecated: Retrieves a list of all code list values matching the given code list ID and by data type.

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

dataType: string

Data Type. Allowed values are current, history. Default is current.
mode(required): string

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

ID of the study

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 (codeId).

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