Document Lifecycle APIs

The REST APIs to manage the lifecycle of a Web Intelligence document.

The table below indicates the 4.0 and/or 4.1 release in which support for the API was introduced.

Base URL: http://<server_name>:6405/biprws/raylight/v1

Path parameter: <documentID> is the document identifier retrieved from the list of documents.

Query parameter: <snapshotID> is the snapshot identifier retrieved from the list of snapshots.

Action Method URL Since
Updating the State of a Document PUT /documents/<documentID> 4.0 SP5 | 4.1
Creating a Document Snapshot POST /documents/<documentID>/snapshots 4.0 SP6 | 4.1
Getting the List of Snapshots GET /documents/<documentID>/snapshots 4.0 SP6 | 4.1
Restoring a Document to a Snapshot PUT /documents/<documentID>/?snapshotId=<snapshotID> 4.0 SP6 | 4.1