Updating the Definition of a Document Input Control

Usage

Updates the details of an input control of a document, such as a name or description.

Request

PUT /documents/<documentID>/inputcontrols/<inputControlID>

Request type: application/xml or application/json

The update of an input control must adhere to the following rules:

  • You cannot change the widget of an input control.
  • The input control must have at least one assigned report element.
  • You can change the assigned data object, but it must be compatible with the widget.
  • You can change the operator, but it must be compatible with the widget.
Response

Response type: application/xml or application/json

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

Example

PUT /documents/6671/inputcontrols/D.IF0

Request body:

<inputcontrol> 
    <name>V_update</name>  
    <comboBox allowAllValuesSelection="true" useCustom="false" operator="GreaterOrEqual"/> 
    <assignedDataObject refId="DP0.DO2"/>  
</inputcontrol>

Response:

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