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

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

Error

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.