Get IDs of all artifacts in an approved study
get
/ec-designer-svc/rest/v2.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
-
formCategory: string
Return forms with this Form Category.Default Value:
DCS
-
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:
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 : Object
Type:
object
Title:
Object
Object with error details information.
500 Response
Error
Root 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 : Object
Type:
object
Title:
Object
Object with error details information.