Getting the Definition of a Document Input Control

Usage

Returns the details of an input control of a document.

Request

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

Response

Response type: application/xml or application/json

Example

Combo Box (XML)
GET /documents/6671/inputcontrols/D.IF0

Response

<inputcontrol> 
    <id>D.IF0</id>  
    <name>Country</name>  
    <comboBox allowAllValuesSelection="true" useCustom="false" operator="Equal"/>  
    <assignedDataObject refId="DP0.DO39" kind="Expression"/>  
    <assignedReportElements> 
        <assignedReportElement refId="D" reference="D.IF0.T0"/> 
    </assignedReportElements> 
</inputcontrol>

Example

CheckBox (JSON)

GET /documents/5152/inputcontrols/D.IF0

Response:

{"inputcontrol":
    {"id":"D.IF0",
     "name":"my checkbox_1",
     "checkBox":
        {"@numberOfLines":"5",
         "@useCustom":"false",
         "@allowAllValuesSelection":"true",
         "@operator":"InList"},
     "assignedDataObject":
        {"@kind":"Expression",
         "@refId":"DP0.DO1fc"},
     "assignedReportElements":
        {"assignedReportElement":
            {"@reference":"D.IF0.T0",
             "@refId":"D"}
        }
    }
}