Adding an Input Control

Adds a new input control to a report.

Request

POST <webiURL>/documents/{documentId}/reports/{reportId}/inputcontrols

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • {reportId} is the report identifier retrieved from the list of reports

The request body must adhere to the following rules:

  • The widget must be compatible with the assigned data object, for example: slide on a measure, radio buttons on a dimension.
  • The input control must have at least one assigned report element.
  • The widget must be compatible with the operator.
Response

Response type: application/xml or application/json

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

Example

POST <webiURL>/documents/7216/reports/3/inputcontrols

Request body:

<inputcontrol>
    <name>Slider on Revenue</name>
    <slider minValue="30000" maxValue="600000" increment="1000" cardinality="Single" 
        operator="Greater"/>
    <assignedDataObject refId="DP0.DO7"/>
    <assignedReportElements>
        <assignedReportElement refId="2"/>
    </assignedReportElements>
</inputcontrol>

Response:

<success>
    <message>The resource of type 'InputControl' with identifier 'R3.IF6' has been 
        successfully created.</message>
    <id>R3.IF6</id>
</success>