Jump to

• Request
• Response

V2.0

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 (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Query Parameters

• all: boolean
  Include all study artifacts. Optional.

  Default Value: false

  Example:

  false

• arms: boolean
  Include treatment arms. Optional.

  Default Value: false

  Example:

  false

• calculateddoses: boolean
  Include calculated doses. Optional.

  Default Value: false

  Example:

  false

• cohorts: boolean
  Include cohorts and cohort factors. Optional.

  Default Value: false

  Example:

  false

• formCategory: string
  Return forms with this Form Category. Optional.

  Default Value: DCS

  Example:

  DCS

• forms: boolean
  Include forms. Optional.

  Default Value: false

  Example:

  false

• inclEverApproved: boolean
  Include study artifacts that were ever approved. Optional.

  Default Value: false

  Example:

  false

• items: boolean
  Include items. Optional.

  Default Value: false

  Example:

  false

• kits: boolean
  Include kits. Optional.

  Default Value: false

  Example:

  false

• rands: boolean
  Include randomization. Optional.

  Default Value: false

  Example:

  false

• visits: boolean
  Include visits. Optional.

  Default Value: false

  Example:

  false

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"
    }
}

Examples

Select an example successResponse

404 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

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

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

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