Interface Document

The ids of any assets referred to in the document

Example

[42,101]
Copy

The author of the document

Example

William Shakespeare
Copy

When the document was created, measured in milliseconds since 00:00:00 Thursday, 1 January 1970. We do a best effort to determine the created time for the document, and it will be derived from either the document metadata, the user-specified created time provided when uploading the file or as a last resort the creation timestamp of the underlying file resource.

Example

1519862400000
Copy

Extension of the file (always in lowercase)

Example

pdf
Copy

The external ID for the document. This field will be the same as the value set in the Files API.

Example

haml001
Copy

Geolocation derived for this document. Represented using a GeoJSON Geometry.

The derived geolocation also includes geolocation information from a matched asset (see assetIds property). For matched assets without geolocation information the parent chain is followed until it finds an asset with geolocation information.

The unique identifier for the document. This is automatically generated by CDF, and will be the same as the corresponding value in the Files API.

Example

2384
Copy

The instance ID for documents created through Data Modeling. This field will be the same as the value set in the Files API.

The detected language used in the document

Example

en
Copy

When the document was last indexed in the documents search engine, measured in milliseconds since 00:00:00 Thursday, 1 January 1970.

Example

1521062805000
Copy

Detected mime type for the document

Example

text/plain
Copy

When the document was last modified, measured in milliseconds since 00:00:00 Thursday, 1 January 1970. This holdes the user-specified modified time provided for the underlying file resource, but might in the future also be derived from document metadata.

Example

1519958703000
Copy

Number of pages for multi-page documents

Format

int32

Example

2
Copy

The producer of the document. Many document types contain metadata indicating what software or system was used to create the document.

The source file that this document is derived from.

The title of the document

Example

Hamlet
Copy

The textual content of the document. Truncated to 155 characters but subject to change

Example

ACT I
SCENE I. Elsinore. A platform before the castle.
  FRANCISCO at his post. Enter to him BERNARDO
BERNARDO
  Who's there?
Copy

Detected type of document

Example

Document
Copy