Jump to

• Request
• Response

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

get

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

Retrieves a list of IDs of all artifacts in a study in Testing, Approved and/or Archived.

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
• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: string(uuid)

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

404 Response

Error

Body ()

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

Body ()

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

Back to Top