Jump to

• Request
• Response

[Deprecated]: Get code list by code name

get

/ec-codelist-svc/rest/v3.0/codelist/{name}

Deprecated: Retrieves code list value matching the given code name and data type.

Request

Path Parameters

• name(required): string
  Name of the codelist.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : CodeListDto

Type: object

Show Source

• codeName: string
• codeType: string
• comment: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• optLock: string (date-time)
• reason: string
• softwareVersionNumber: number
• userId: string (uuid)
• values: array values
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "codeName":{
            "type":"string"
        },
        "codeType":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string",
            "writeOnly":true
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object CodeValueDto

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

Nested Schema : CodeValueDto

Type: object

Show Source

• codeId: string (uuid)
• codeLabel: string
• codeValue: string
• comment: string
• id: string (uuid)
• locale: string
• objectVersionNumber: number
• operationType: string
• optLock: string (date-time)
• reason: string
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "codeId":{
            "type":"string",
            "format":"uuid"
        },
        "codeLabel":{
            "type":"string"
        },
        "codeValue":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "locale":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string",
            "writeOnly":true
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        }
    }
}

400 Response

'Internal server error', 'Invalid version number','Missing required field (codeName)'

Body ()

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

Back to Top