Jump to

• Request
• Response

[Deprecated]: Get list of all code lists by code list type

get

/ec-codelist-svc/rest/v3.0/codelist

Deprecated: Retrieves a list of all code lists by code list type. The parameter code listType is reserved for a future release.

Request

Query Parameters

• allFields: boolean
  Indicates whether hidden fields need to be retrieved. Allowed values are true or false.
• codelistType: string
  Type of the codelist. Allowed values are USER, CUSTOM, SYSTEM, APPLICATION.

  Allowed Values: [ "USER", "CUSTOM", "SYSTEM", "APPLICATION" ]
• mode: string
  Mode of the study. Allowed values are active, test and training
• studyId: 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 : Code

Type: object

Show Source

• canAddValues: boolean
• canHideValues: boolean
• codeGroupId: string (uuid)
• codeLevel: string
  Minimum Length: 1

  Maximum Length: 32
• codeName: string
  Minimum Length: 1

  Maximum Length: 255
• codeType: string
  Minimum Length: 1

  Maximum Length: 255
• comment: string
• customizable: boolean
• description: string
  Minimum Length: 1

  Maximum Length: 4000
• displayCodeName: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• optlock: string (date-time)
• parCodeName: string
  Minimum Length: 1

  Maximum Length: 255
• reason: string
• softwareVersionNumber: number
• tag: string
  Minimum Length: 1

  Maximum Length: 32767
• tenantLevelOnly: boolean
• 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":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "optlock":{
            "type":"string",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "codeName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "codeType":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "codeLevel":{
            "maxLength":"32",
            "minLength":"1",
            "type":"string"
        },
        "parCodeName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "description":{
            "maxLength":"4000",
            "minLength":"1",
            "type":"string"
        },
        "tag":{
            "maxLength":"32767",
            "minLength":"1",
            "type":"string"
        },
        "codeGroupId":{
            "type":"string",
            "format":"uuid"
        },
        "displayCodeName":{
            "type":"string"
        },
        "canAddValues":{
            "type":"boolean"
        },
        "canHideValues":{
            "type":"boolean"
        },
        "customizable":{
            "type":"boolean"
        },
        "tenantLevelOnly":{
            "type":"boolean"
        }
    }
}

400 Response

Invalid request URL.

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