Get data elements to be coded using source IDs
post
/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus
Retrieve data elements to be coded based on 'codeType' parameter and list of source IDs.
Request
Query Parameters
-
codeType: string
type of coded questions to be fetchedallowed values NeedsCodingOrDeleted and NeedsCoding
Supported Media Types
- */*
Response
Supported Media Types
- application/json
200 Response
Success
Nested Schema : CodedDerrivedItemsRequest
Type:
Show Source
object-
codeValuesList: array
codeValuesList
-
source_propertyId: string
-
source_value(required): string
Minimum Length:
0Maximum Length:4000
Nested Schema : CodeValue
Type:
Show Source
object-
code: string
Minimum Length:
1Maximum Length:255 -
codeGroupId: string
(uuid)
-
codeId: string
(uuid)
-
codeLabel: string
Minimum Length:
1Maximum Length:32767 -
codeValue: string
Minimum Length:
1Maximum Length:32767 -
comment: string
-
customizationType: string
- hidden: boolean
-
id: string
(uuid)
-
language: string
Minimum Length:
1Maximum Length:10 -
locale: string
Minimum Length:
1Maximum Length:255 -
loinc: string
-
objectVersionNumber: number
-
operationType: string
Minimum Length:
1Maximum Length:16 -
optlock: string
(date-time)
-
reason: string
-
sequence: number
-
softwareVersionNumber: number
-
userId: string
(uuid)
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
400 Response
Bad Request
Root Schema : DcsResponse
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
-
version: integer
(int32)
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