Updating the Definition of an Input Control

Usage

Updates the details of an input control of a report.

Request

PUT /documents/<documentID>/reports/<reportID>/inputcontrols/<inputControlID>

The update of an input control must adhere to the following rules:

  • You cannot change the widget of an input control.
  • The input control must have at least one assigned report element.
  • You can change the assigned data object, but it must be compatible with the widget.
  • You can change the operator, but it must be compatible with the widget.
Response

Response type: application/xml or application/json

The response is a message stating the success or failure of the request.

Example

PUT /documents/7214/reports/1/inputcontrols/R1.IF2

Request body:

<inputcontrol>
    <name>IC Label</name>
    <radioButtons allowAllValuesSelection="true" useCustom="false" numberOfLines="5" operator="NotEqual"/>
    <assignedDataObject refId="DP0.DO4"/>
    <assignedReportElements>
        <assignedReportElement refId="2"/>
    </assignedReportElements>
</inputcontrol>

Response:

<success>
    <message>The resource of type "InputControl" with identifier "R1.IF2" has been uccessfully updated.</message>
    <id>R1.IF2</id>
</success>