Document data

The document data structure describes a document.

{
  "document_uuid": "uuid",
  "document_title":"Document title",
  "document_description":"Document description",
  "document_type_reference": "ref",
  "document_type_name": "Document type",
  "document_received_timestamp": "yyyy-mm-ddThh:mm:ss.ttt",
  "document_date": "yyyy-mm-dd",
  "document_valid_from_date": "yyyy-mm-dd",
  "document_valid_to_date": "yyyy-mm-dd",
  "document_status_reference": "ref",
  "document_status_name": "name",
  "document_key": "document/path",
  "document_tags": "tag1 tag2 tag3...",
  "document_data": {
    .. other data ..
  },
  "document_file": {
    .. file info object ..
  }
}

When returned from Insight, the file info object may not be resolvable by the calling process. Use the get_file component to retrieve a file info object that can be resolved.

Document tags can either be a blank-delimited list of simple tokens (as shown), an array, or a JSON string holding an array. If a JSON string is passed, search results will return it as an array.

The document key is a path-like reference to the document, e.g. "supplier/123456/nda". This can be used to retrieve the document. If more than one document has the same key, only the one with the latest document_received_timestamp is returned.

Document data can be a string, an object, or a JSON string holding an object. If a JSON string is passed, search results will return it as an object. FileInfo objects within the document data may be shown as document attachments.