Jump to

• Request
• Response

[Deprecated]: V1.0

post

/ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/choiceoptions

Deprecated: Use latest version instead. Retrieves options of all choice items by study mode and form ID(s).

Request

Path Parameters

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

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

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

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Query Parameters

• mode(required): string
  Retrieves all form items in a form by mode.

  Allowed Values: [ "test", "training", "active" ]

  Example:

  test

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: string

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

Examples

Select an example requestExample

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

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