Get historical code lists by name
get
/ec-codelist-svc/rest/v1.0/codelist/search
Retrieves historical code lists by name.
Request
Query Parameters
-
name(required): string
Name of the codelist.
-
studyId(required): string(uuid)
ID of a Study. Only required if level path parameter equals to 'studies'
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:
1Maximum Length:32 -
codeName: string
Minimum Length:
1Maximum Length:255 -
codeType: string
Minimum Length:
1Maximum Length:255 -
comment: string
-
customizable: boolean
-
description: string
Minimum Length:
1Maximum Length:4000 -
displayCodeName: string
-
id: string
(uuid)
-
objectVersionNumber: number
-
operationType: string
Minimum Length:
1Maximum Length:16 -
optlock: string
(date-time)
-
parCodeName: string
Minimum Length:
1Maximum Length:255 -
reason: string
-
softwareVersionNumber: number
-
tag: string
Minimum Length:
1Maximum Length:32767 -
tenantLevelOnly: boolean
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
400 Response
Invalid request URL.
Root Schema : CodeListResponse
Type:
Show Source
object-
errorData: object
ErrorResponseData
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
-
result: object
result
-
status: string
Nested Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type:
object