Get IDs of all artifacts in an approved study
get
/ec-designer-svc/rest/v1.0/studies/{studyId}/approved/objectids
Retrieves a list of IDs of all artifacts in a specified approved study. An artifact refers to anything that belongs to the study design, for example: forms, randomization, treatment arm, kits, etc.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
Query Parameters
-
all: boolean
Include all study artifactsDefault Value:
false -
arms: boolean
Include treatment armsDefault Value:
false -
calculateddoses: boolean
Include calculated dosesDefault Value:
false -
cohorts: boolean
Include cohorts and cohort factorsDefault Value:
false -
forms: boolean
Include formsDefault Value:
false -
inclEverApproved: boolean
Include study artifacts which are ever approvedDefault Value:
false -
items: boolean
Include itemsDefault Value:
false -
kits: boolean
Include kitsDefault Value:
false -
rands: boolean
Include randomizationDefault Value:
false -
visits: boolean
Include visitsDefault Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
404 Response
Error
Root 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
500 Response
Error
Root 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