Get snapshot of code list asDate based on studyId, codeListId, hidden, language
get
/ec-codelist-svc/rest/v1.0/codelist/values/asOfDate/{id}
Get snapshot of code list asDate based on studyId, codeListId, hidden, language
Request
Path Parameters
-
id(required): string(uuid)
Name of the fields. It can be code name, tag name or code ID.
Query Parameters
-
asofdate(required): string
Date till where data is required
-
includeHidden: boolean
Indicates whether hidden code values should be returned. Allowed values are true or false. Default is falseDefault Value:
false -
language: string
Language for expected response codelist. This overrides user preference for language. This field is case sensitive and accepts values like en, ja etc. By default it's english (en)
-
studyId(required): 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
Nested Schema : code
Type:
objectNested Schema : items
Type:
object400 Response
Missing required field (codeName).
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: object
details
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
-
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:
objectNested Schema : details
Type:
objectDetailed 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: userId500 Response
Internal server error
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: object
details
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
-
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:
objectNested Schema : details
Type:
objectDetailed 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