REST API for Clinical One Platform

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.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

all: boolean

Include all study artifacts

Default Value: false
arms: boolean

Include treatment arms

Default Value: false
calculateddoses: boolean

Include calculated doses

Default Value: false
cohorts: boolean

Include cohorts and cohort factors

Default Value: false
forms: boolean

Include forms

Default Value: false
inclEverApproved: boolean

Include study artifacts which are ever approved

Default Value: false
items: boolean

Include items

Default Value: false
kits: boolean

Include kits

Default Value: false
rands: boolean

Include randomization

Default Value: false
visits: boolean

Include visits

Default Value: false

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

404 Response

Error

Root Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

500 Response

Error

Root Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object