Moving an Input Control from a Report to a Document

Usage

Moves an input control from a report to a document. The input control obtains a new identifier after the move, but keeps the same data objects.

Request

PUT /documents/<documentID>/inputcontrols/<inputControlID>?fromId=<fromID>

Where:

  • <fromID> is the input control ID in the report
Response

Response type: application/xml or application/json

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

Example

PUT documents/6660/inputcontrols?fromId=R1.IF3

Response:

<success> 
    <message>The resource of type "Input Control" with identifier "R1.IF3" has been successfully moved.</message>  
    <id>D.IF0</id> 
</success>

The <id> is the new identifier of the input control in the document.

Another call to retrieve the definition of the input control shows a fake report element of identifier D associated with the control in the document.

GET documents/6660/inputcontrols/D.IF0

Response:

<inputcontrol> 
    <id>D.IF0</id>  
    <name>Revenue</name>  
    <slider minValue="30000.0" maxValue="600000.0" increment="1000.0" cardinality="Interval" operator="Between"> 
        <default> 
            <value>30000</value>  
            <value>600000</value> 
        </default> 
    </slider>  
    <assignedDataObject refId="DP0.DO7" kind="Expression"/>  
    <assignedReportElements> 
        <assignedReportElement refId="D" reference="D.IF0.T0"/> 
    </assignedReportElements> 
</inputcontrol>