REST API for Clinical One Platform

Get IDs of all artifacts in a study in a specific mode

get

/ec-designer-svc/rest/v2.0/studies/{studyId}/objectids

Retrieves a list of IDs of all artifacts in a study in Testing, Approved and/or Archived. 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 artifacts.

Default Value: false
archived: boolean

Include the archived versions of a study in a specified mode.

Default Value: true
formCategory: string

Return forms with this Form Category.

Default Value: DCS
forms: boolean

Include forms.

Default Value: false
items: boolean

Include form items.

Default Value: false
studymode: array[string]
Include list of study modes where the artifacts are located.
- Allowed Values: [ "design", "test", "training", "active", "all" ]
```
[
    "design",
    "test",
    "training",
    "active",
    "all"
]
```

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

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-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

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-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.