Creating a Document

Usage

Creates an empty Web Intelligence document.

Request

POST /documents

Request type: application/xml or application/json

Request body:

<document>
    <name>
    <folderId>
Element Type or Value Description
<name> string The name of the document to be created.
<folderId> integer The BI launch pad folder where the document is created. You can retrieve the folder ID from a GET call to http://<server-name>:6405/biprws/infostore.
Response

Response type: application/xml or application/json

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

Example

XML Example

POST /documents

Request body:

<document>
    <name>My Document</name>
    <folderId>5151</folderId>
</document>

Response body:

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

Example

JSON Example

POST /documents

Request body:

{"document":
    {"name": "my document",
     "folderId:"5151"}
}

Response body:

{"success":
   {"message": "The resource of type "Document" with identifier "5022" has been successfully created.",
    "id": 5022}
}
An identifier has been assigned automatically.