Creating a Document Snapshot

Creates a snapshot of a Web Intelligence document. The call returns the identifier of the newly created storage token.

You can customize one step and go back and forth between initial state and resulting state. This can be used as undo/redo or implement custom prompt dialog boxes.

Request

POST <webiURL>/documents/{documentId}/snapshots

Where:

  • {documentId} is the document identifier retrieved from the list of documents
Response

Response type: application/xml or application/json

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

Example

POST <webiURL>/documents/8022/snapshots

<success> 
    <message>The resource of type "Snapshot" with identifier "we00000000e3667716ec10" has been successfully created.</message>  
    <id>we00000000e3667716ec10</id> 
</success>