Jump to

• Request
• Response

V2.0

get

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

Returns approved study design object IDs for the specified study. Compared with v1.0, this version adds formCategory filtering for form and form item IDs.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Query Parameters

• all: boolean
  Include all supported approved study design object types. Optional.

  Default Value: false

  Example:

  false

• arms: boolean
  Include approved treatment arm IDs. Optional.

  Default Value: false

  Example:

  false

• calculateddoses: boolean
  Include approved calculated dose IDs. Optional.

  Default Value: false

  Example:

  false

• cohorts: boolean
  Include approved cohort and cohort factor IDs. Optional.

  Default Value: false

  Example:

  false

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

  Default Value: DCS

  Example:

  DCS

• forms: boolean
  Include approved form IDs. Optional.

  Default Value: false

  Example:

  false

• inclEverApproved: boolean
  Return form and form item IDs that were ever approved instead of only currently approved IDs. Optional.

  Default Value: false

  Example:

  false

• items: boolean
  Include approved form item IDs. optional.

  Default Value: false

  Example:

  false

• kits: boolean
  Include approved kit IDs. Optional.

  Default Value: false

  Example:

  false

• rands: boolean
  Include approved randomization IDs. Optional.

  Default Value: false

  Example:

  false

• visits: boolean
  Include approved visit IDs. 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)
  Approved study design object ID (UUID, 32-character uppercase hexadecimal string).

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Approved study design object ID (UUID, 32-character uppercase hexadecimal string).",
        "format":"uuid",
        "example":"B1B8327AFAA6412287106192AB5984EF"
    }
}

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

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

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

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top