Get a list of all code lists by code list type
get
/ec-codelist-svc/rest/v4.0/codelist
Retrieves a list of all code lists by code list type. To retrieve code lists for a particular Group, groupId param must be passed.
Request
Query Parameters
-
codeName: string
codeName. Search codelists by a query (code name or a part of it). Case-Insensitive
-
codelistType: string
Type of the codelist. Allowed values are CUSTOM, and SYSTEM. USER and APPLICATION are not supportedAllowed Values:
[ "USER", "CUSTOM", "SYSTEM", "APPLICATION" ]
-
groupId: string(uuid)
Id of a CodeList group. When specified, returns codelists of the group (including non-customized SYSTEM default codelists)
-
mode: string
Mode of the study. Allowed values are active, test and training
-
sortBy: string
sortBy. By default list is sorted by name in alphabetical orderDefault Value:
codeName:asc
-
studyId: string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Root Schema : Code
Type:
Show Source
object
-
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)
400 Response
Invalid request URL.
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object