/knowledge/document/get/{docid}?returnFullText=[true|false|1|0]&returnRawData=[true|false|1|0]
/knowledge/document/get/{sourceKey}/{url}?returnFullText=[true|false|1|0]&returnRawData=[true|false|1|0]
Info |
---|
Returns a document (TODO link to document object) matching the id number (or sourceKey/URL) provided. |
Authentication
Required, see Auth - Login
Arguments
docid (required )
id of the document of which to return the metadata- unless sourceKey/URL specified)
id of the document of which to return the metadata
sourceKey (required - unless docid specified)
URL (required - unless docid specified)
Instead of specifying the document "_id", the sourceKey together with a URL-encoded URL can be specified (the 2 uniquely define any document within Infinit.e).
returnFullText (optional)
By default, the text of the document is not returned. Setting this parameter to "true" or "1" will return the first 50KB of the content, in the "fullText" JSON field (see below).
returnRawData (optional)
Only applies to files - if set to true (default is false) then returns the raw file directly from the fileshare. The extension of the stored filename is used to determine the reported encoding type. For non-files, this parameter is ignored.
Example
http://infinite.ikanow.com/api/knowledge/document/get/4cc0ebff97622e5914a70e83
http://infinite.ikanow.com/api/knowledge/document/get/4cc0ebff97622e5914a70e83?returnFullText=1
Example Response
Info | ||
---|---|---|
|