Setting the Selection of a Document Input Control

Usage

Sets the values selected for an input control of a document.

Request

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

Request body: the values can be obtained by getting the list of values from the assigned data object using the call GET /documents/<documentID>/dataobjects/<dataObjectID>/lov.

Response

Response type: application/xml or application/json

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

Example

XML

PUT /documents/6671/inputcontrols/D.IF0/selection

Request body:

<selection>
    <value>France</value>
    <value>Germany</value>
</selection>

Response:

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

Example

JSON

PUT /documents/5152/inputcontrols/D.IF0/selection

Request body:

{"selection":
    {"value":["Bermudas","Boatwear"]}
    }

Response:

{"success":
    {"message":"The resource of type \"Input Control Selection\" with identifier \"D.IF0\" has been successfully updated.",
     "id":"D.IF0"}
}