Getting the Input Controls of a Report

Lists all the input controls of a report.

Request

GET <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
Response

Response type: application/xml or application/json

Response body: the list of input control identifiers and names.

Example

GET <webiURL>/documents/6452/reports/1/inputcontrols

Response:

<inputcontrols>
    <inputcontrol>
        <id>R1.IF0</id>
        <name>Country</name>
    </inputcontrol>
    <inputcontrol>
        <id>R1.IF1</id>
        <name>Service Line</name>
    </inputcontrol>
    <inputcontrol>
        <id>R1.IF2</id>
        <name>Year</name>
    </inputcontrol>
    <inputcontrol>
        <id>R1.IF3</id>
        <name>Revenue</name>
    </inputcontrol>
    <inputcontrol>
        <id>R1.IF4</id>
        <name>var1_serviceline</name>
    </inputcontrol>
    <inputcontrol>
        <id>R1.IF5</id>
        <name>var2_revenue</name>
    </inputcontrol>
</inputcontrols>