Saving a Document

Saves a Web Intelligence document to a folder of the user machine.

When you save a document, it is copied to the destination folder and an identifier is assigned automatically.

Request

POST <webiURL>/documents/{documentId}

Where:

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

Request body:

<document>
    <name>
    <folderId>

Where:

  • <name> is the name of the document to save.
  • <folderId> is the identifier of the BI launch pad destination folder.
Note Use -1 as folder identifier to save the document to the same folder.
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/1234

Request body:

<document>
    <name>CopiedDocument</name>
    <folderId>2906</folderId>
</document>

Response:

<success>
   <message>The resource of type 'Document' has been successfully created.</message>
   <id>5678</id>
</success>
An identifier has been assigned automatically.