Getting the Definition of an Input Control

Usage

Returns the details of an input control of a report.

Request

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

Response

Response type: application/xml or application/json

Example

Calendar
<inputcontrol> 
    <id>R2.IF3</id>  
    <name>Invoice Date (type:DateTime)</name>  
    <calendar useCustom="false" operator="Equal"/>  
    <assignedDataObject refId="DP2.DO17" kind="Expression"/>  
    <assignedReportElements> 
        <assignedReportElement refId="1" reference="R2.IF3.T0"/> 
    </assignedReportElements> 
</inputcontrol>

Example

Check Box
<inputcontrol> 
    <id>R1.IF0</id>  
    <name>Country</name>  
    <checkBox allowAllValuesSelection="true" useCustom="false" numberOfLines="5" operator="InList"> 
        <default> 
            <value>France</value>  
            <value>US</value> 
        </default> 
    </checkBox>  
    <assignedDataObject refId="DP0.DO6" kind="Expression"/>  
    <assignedReportElements> 
        <assignedReportElement refId="15" reference="R1.IF0.T0"/> 
    </assignedReportElements> 
</inputcontrol>

Example

Combo Box
<inputcontrol> 
    <id>R2.IF2</id>  
    <name>var1_serviceline</name>  
    <comboBox allowAllValuesSelection="true" useCustom="false" operator="Equal"/>  
    <assignedDataObject refId="L1" kind="Variable"/>  
    <assignedReportElements> 
        <assignedReportElement refId="1" reference="R2.IF2.T0"/> 
    </assignedReportElements> 
</inputcontrol>

Example

List Box
<inputcontrol> 
    <id>R1.IF1</id>  
    <name>Service Line</name>  
    <listBox allowAllValuesSelection="true" useCustom="false" numberOfLines="5" cardinality="Multiple" operator="InList"> 
        <default> 
            <value>Accommodation</value>  
            <value>Food &amp; Drinks</value> 
        </default> 
    </listBox>  
    <assignedDataObject refId="DP0.DO4" kind="Expression"/>  
    <assignedReportElements> 
        <assignedReportElement refId="15" reference="R1.IF1.T0"/> 
    </assignedReportElements> 
</inputcontrol>

Example

Radio Button
<inputcontrol>
    <id>R1.IF2</id>
    <name>Year</name>
    <radioButtons allowAllValuesSelection="true" useCustom="false" numberOfLines="5" operator="Equal"/>
    <assignedDataObject refId="DP0.DO18" kind="Expression"/>
    <assignedReportElements>
        <assignedReportElement refId="15" reference="R1.IF2.T0"/>
    </assignedReportElements>
</inputcontrol>

Example

Slider
<inputcontrol> 
    <id>R1.IF3</id>  
    <name>Revenue</name>  
    <slider minValue="30000" maxValue="600000" increment="1000" cardinality="Interval" operator="Between"> 
        <default> 
            <value>30000</value>  
            <value>600000</value> 
        </default> 
    </slider>  
    <assignedDataObject refId="DP0.DO7" kind="Expression"/>  
    <assignedReportElements> 
        <assignedReportElement refId="15" reference="R1.IF3.T0"/> 
    </assignedReportElements> 
</inputcontrol>

Example

Spinner
<inputcontrol> 
    <id>R1.IF5</id>  
    <name>var2_revenue</name>  
    <spinner minValue="10" maxValue="15" increment="1" operator="Equal"> 
        <default> 
            <value>11</value> 
        </default> 
    </spinner>  
    <assignedDataObject refId="L2" kind="Variable"/>  
    <assignedReportElements> 
        <assignedReportElement refId="20" reference="R1.IF5.T0"/> 
    </assignedReportElements> 
</inputcontrol>

Example

Text Field
<inputcontrol> 
    <id>R2.IF1</id>  
    <name>Year</name>  
    <textField operator="Equal"> 
        <default> 
            <value>FY93</value> 
        </default> 
    </textField>  
    <assignedDataObject refId="DP0.DO18" kind="Expression"/>  
    <assignedReportElements> 
        <assignedReportElement refId="1" reference="R2.IF1.T1"/> 
    </assignedReportElements> 
</inputcontrol>

Example

Tree List
<inputcontrol> 
    <id>R2.IF4</id>  
    <name>Customer Geography</name>  
    <treeList numberOfLines="5" cardinality="Multiple" allowComplexSelection="true" operator="InList"/>  
    <assignedDataObject refId="DP1.DO9d" kind="Expression"/>  
    <assignedReportElements> 
        <assignedReportElement refId="1" reference="R2.IF4.T0"/> 
    </assignedReportElements> 
</inputcontrol>