[Deprecated]: Get a code list matching the given code name in the payload
get
/ec-codelist-svc/rest/v2.0/codelist
Deprecated: Retrieves a list of all latest code lists, with code list version less than or equal to the specified value matching the given code name. The parameters codelistType, studyId & modes are reserved for a future release.
Request
Query Parameters
-
softwareReleaseNumber: string
Maximum version of the codelist to be retrieved.
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 version number.
Root Schema : CodeListResponse
Type:
Show Source
object
-
errorData: object
ErrorResponseData
Title:
ErrorResponseData
Error Response Details Information -
result: object
result
-
status: string
Nested Schema : ErrorResponseData
Type:
object
Title:
ErrorResponseData
Error Response Details Information
Show Source
-
details: object
Object
Title:
Object
Object with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : result
Type:
object
Nested Schema : Object
Type:
object
Title:
Object
Object with error details information.