Usage
Cancels the refresh of a Web Intelligence document that is being refreshed. If no
execution is currently running, this has no effect.
Request
PUT
/documents/<documentID>/parameters?execution?cancel=<mode>
Where:
- <mode> defines how the cancel is
managed:
- partial: when
the cancel is performed, this displays the new values retrieved so far
in the appropriate parts of the document. The rest of the document will
display the values retrieved the last time the query was run.
- restore: when
the cancel is performed, this restores the values to the document that
were retrieved the last time the query was run. The values displayed
will not be the most up to data information available on the database.
You can run the query later to return the up to date values from the
database.
- purge: when
the cancel is performed, this displays the document empty of values. The
structure and formatting of the document is retained. You can run the
query later to return the up to date values from the database.
Response
Response type:
application/xml or
application/json
The response is a message stating the success or failure of the
request.
Example
PUT /documents/8022/parameters/execution?cancel=partial
<success>
<message>The resource of type "Document" with identifier "8022" has been successfully updated.</message>
<id>8022</id>
</success>