Refreshing a Document

Refreshes a Web Intelligence document.

When a document does not need any parameters to be refreshed, you can omit the request body. When a document needs parameters, the server lists the required parameters in an iterative way if the user does not provide them. For documents which need parameters, if the user does not want to send any, a parameter must be sent but without the answer block.

Request

PUT <webiURL>/documents/{documentId}/parameters?lovInfo={true|false}

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • lovInfo is an optional, Boolean parameter. Default value is true. If set to false, the lists of values are not computed, nor displayed.

Request body:

<parameters>
    <parameter optional="true|false" type="context|prompt">  
        <id>...</id>
        <answer constrained="true" type="Text|Numeric|DateTime">
            <values>
                <value id="...">...</value>
            </values>
        </answer>
    </parameter> 
</parameters>

Request body (JSON):

{"parameters":{"parameter":{"id":0,"answer":{"values":{"value":{"@id":"2"}}}}}}

Where:

  • Parameter id is retrieved from the GET request result.
  • Parameter type is either context or prompt.
  • Answer type is either Text, Numeric or DateTime.

    dateTime is of the format: yyyy-mm-ddThh:mm:ss.sss+HH:MM HH:MM is the time zone offset. Example: 1992-09-03T17:15:00.000+02:00.

  • Value id is retrieved from the GET request result (<info>).
Response

Response type: application/xml or application/json

See the following sections to know the possible responses depending on the parameters to be refreshed.