Gets the details of a Web Intelligence document.
Request
GET
<webiURL>/documents/{documentId}
Where:
- {documentId} is the document
identifier retrieved from the list of documents
Response
Response type:
application/xml or
application/json
Response body: the details of the document
identified by the following:
- <id>: document identifier
- <cuid>: CUID of the document
- <name>: document name
- <folderId>: identifier of the folder of the CMS repository that contains
the document
- <path>: path to the document in the CMS repository directory
- <updated>: date and the time of the last update
-
<scheduled>: which is true if the
document has been scheduled
- <createdBy>: the name of the document creator
- <lastAuthor>: the name of the last person who modified the document
- <size>: the size of the document in bytes
- <refreshOnOpen>: which is true if the document is set to
be refreshed at the open time
- <state>: 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
Example
GET
<webiURL>/documents/4958
<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>