REST API for Clinical One Platform

Get options of all choice items by study mode and form ID(s)

post

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

Retrieves options of all choice items by study mode and form ID(s).

Request

Path Parameters

formId(required): string(uuid)
studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

allowHiddenOptions: boolean
items: string
mode(required): string

Retrieves all form items in a form by mode.

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

Supported Media Types

Root Schema : schema

Type: array

Show Source

Array of: string

Example: C138D4523012443F93F34CC3F281B675

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

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object FormOptionDto

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

Nested Schema : FormOptionDto

Type: object

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

404 Response

Error

Root Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

500 Response

Error

Root Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}