Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 6.81 KB

PlatformDocument.md

File metadata and controls

18 lines (15 loc) · 6.81 KB

PlatformDocument

Fields

Field Type Required Description
documentId String ✔️ Indexed Glean store ID. Get document by ID accepts it.
url String ✔️ Permalink of the document. Pass it to get document by URL to retrieve the document again. May differ from a submitted lookup URL.
title String ✔️ Document title. The server returns the placeholder title, Untitled, when the source item has no title.
datasource String ✔️ Origin datasource.
documentType Optional<String> ✔️ Datasource-specific document type.
mimeType Optional<String> ➖ Source MIME type. Omitted when absent.
creator Optional<PlatformPersonReference> ➖ A lightweight reference to a person, used where a payload merely points at someone.
owner Optional<PlatformPersonReference> ➖ A lightweight reference to a person, used where a payload merely points at someone.
updatedAt OffsetDateTime ✔️ When the document was last modified.
createdAt OffsetDateTime ✔️ When the document was created.
content Optional<PlatformDocumentContent> ➖ N/A