Getting the List of Documents

Gets the list of Web Intelligence documents stored in the CMS repository.

The documents are sorted by name. The list returned depends on user access rights. You can also specify the number of documents to return and the first document to be used as the start document in the list.

Request

GET <webiURL>/documents?offset={offset}&limit={limit}

Where:

  • {offset} indicates the position in the list, from which documents are returned. {offset} must be greater than or equal to 0. This parameter is optional. The default value is 0.
  • {limit} indicates the number of documents in the list. {limit} range is [0, 50]. This parameter is optional. The default value is 10.
Response

Response type: application/xml or application/json

Response body: a list of Web Intelligence documents sorted by name. For each document:

  • <id>: document ID
  • <cuid>: unique document ID
  • <name>: document name
  • <folderId>: folder ID
  • <state>: the state of the document used by the service. Values can be:
    • Unused, if the document has not been loaded.
    • Original, if the document has been loaded but not modified
    • Modified, if the user sent requests which altered the state of the document

Example

To Get Six Documents from the CMS

GET <webiURL>/documents?limit=6

<documents>
    <document>
        <id>6804</id>
        <cuid>AbrVz6E95lNMtjZk4KLzPuM</cuid>
        <name>BOF-ROLE_AA_ActiveHierOnCtry - Levels 02 and 03</name>
        <folderId>7611</folderId>
        <state>Original</state>
    </document>
    <document>
        <id>6861</id>
        <cuid>AUwfvPdEG3xOoLNoNEzDquQ</cuid>
        <name>This is a sample for BOF-QRY_SIMPLE - Filter not in Result</name>
        <folderId>7611</folderId>
        <state>Unused</state>
    </document>
    <document>
        <id>6869</id>
        <cuid>Ac1wDFEOuvNHtovI4H.anSM</cuid>
        <name>BOF-QRY_SIMPLE - Filter on Country</name>
        <folderId>48162</folderId>
        <state>Original</state>
    </document>
    <document>
        <id>7048</id>
        <cuid>AUiVpegCKnFBh4AX8YxMT5A</cuid>
        <name>BOF-QRY_SIMPLE - Filter on Prompt not in Result</name>
        <folderId>7611</folderId>
        <state>Modified</state>
    </document>
    <document>
        <id>7125</id>
        <cuid>AWa48YHHT6FFiUMP.T5wtBs</cuid>
        <name>BOF-QRY_SIMPLE - Query Prompt not in Result</name>
        <folderId>7611</folderId>
        <state>Unused</state>
    </document>
    <document>
        <id>5121</id>
        <cuid>ARnGKBoLv7lDuK_UWMUli5Q</cuid>
        <name>Chart demo</name>
        <description>Shows how data can be visualized on different kinds of charts. 
            And the features supported on the charts. </description>
        <folderId>5127</folderId>
        <state>Unused</state>
    </document>
</documents>