Getting the Details of a Document

Usage

Gets the details of a Web Intelligence document.

Request

GET /documents/<documentID>?trackerDocumentId=<trackerDocumentID>

Where:
  • <trackerDocumentID>: identifier of a reference document for trackdata feature. Optional. Must be provided only when the document state is unused.
Response

Response type: application/xml or application/json

Response body: the details of the document identified by the following elements:

Element Type or Value Description
<id> Integer The document ID
<cuid> String The unique document ID
<name> String The document name
<description> String The document description
<folderId> Integer The identifier of the folder of the CMS repository that contains the document
<path> String The path to the document in the CMS repository directory
<updated> DateTime The date and the time of the last update
<scheduled> Boolean true if the document has been scheduled
<state> Unused|Original|Modified The state of document used by the service. Possibles values are:
  • Unused, if the document has not been loaded in the web service container
  • Original, if the document has been loaded by the web service but not modified
  • Modified, if the user sent requests which altered the state of the document
<createdBy> String The name of the document creator
<lastAuthor> String The name of the last person who modified the document
<size> Integer The size of the document in bytes
<refreshOnOpen> Boolean true if the document is set to be refreshed at the open time

Example

Getting the Details of a Document (XML)

GET /documents/4958

Response body:

<document>
    <id>4958</id>
    <cuid>AQtkbbSqN4NOj3ydf.Sw1lY</cuid>
    <name>Formatting Sample</name>
    <description>This is a sample document showing formatting capabilities.</description>
    <folderId>8246</folderId>
    <path>My Favorites/web Intelligence</path>
    <updated>2012-09-05T14:25:05.277+02:00</updated>
    <scheduled>true</scheduled>
    <state>Unused</state>
    <createdBy>Administrator</createdBy>
    <lastAuthor>User1</lastAuthor>
    <size>29410</size>
    <refreshOnOpen>false</refreshOnOpen>
</document>

Example

Getting the Details of a Document (JSON)
GET /documents/5152
{"document":
    {"id":5152,
     "cuid":"AZx1nlTlCMdCvyJ6bWUTC5I",
     "name":"Chart Demo",
     "description":"Shows how data can be visualized on different kinds of charts. And the features supported on the charts.",
     "folderId":5151,
     "path":"Public Folders\/Web Intelligence Samples\/Mobile Samples",
     "updated":"2015-04-21T18:10:29.052+02:00",
     "scheduled":false,
     "state":"Unused",
     "createdBy":"Administrator",
     "lastAuthor":"Administrator",
     "size":298874,
     "refreshOnOpen":false}
}