Jump to

• Request
• Response

[Deprecated]: V2.0

get

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

Deprecated: Use latest version instead. Retrieves options of all choice items in the latest approved version.

Request

Path Parameters

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

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Query Parameters

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

  Default Value: DCS

  Example:

  DCS

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: object FormOptionDto
  Choice options

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormOptionDto"
    }
}

Nested Schema : FormOptionDto

Type: object

Choice options

Show Source

• clCode: string
• clDescription: string
  Minimum Length: 1

  Maximum Length: 4000
• clItemId: string (uuid)
• clValue: string
• formCategory: string
• formSubcategory: string
• hidden: boolean
• instructionalText: string
• label: string
  Minimum Length: 1

  Maximum Length: 4000
• optionSeq: string
• value: string
  Minimum Length: 1

  Maximum Length: 4000

{
    "type":"object",
    "properties":{
        "label":{
            "maxLength":4000,
            "minLength":1,
            "type":"string"
        },
        "value":{
            "maxLength":4000,
            "minLength":1,
            "type":"string"
        },
        "clCode":{
            "type":"string"
        },
        "clDescription":{
            "maxLength":4000,
            "minLength":1,
            "type":"string"
        },
        "clValue":{
            "type":"string"
        },
        "formCategory":{
            "type":"string"
        },
        "formSubcategory":{
            "type":"string"
        },
        "instructionalText":{
            "type":"string"
        },
        "clItemId":{
            "type":"string",
            "format":"uuid"
        },
        "hidden":{
            "type":"boolean"
        },
        "optionSeq":{
            "type":"string"
        }
    },
    "description":"Choice options",
    "example":1
}

Example:

1

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top