plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

DriveDocument

DriveDocument

The body of a drive item of kind document: the rich-editor content plnnrly opens when you click a document in the file browser.

View as Markdown
Summary view
DriveDocumentList, 6 fields. What a list returns by default.
Detail view
DriveDocument, 7 fields. The default for a single read and for every write.
Read with
api:read:project_driveorapi:read:customer_driveorapi:read:organization_driveorapi:read:user_driveandproject_drive::access
Write with
api:write:project_driveorapi:write:customer_driveorapi:write:organization_driveorapi:write:user_driveandproject_drive::create

It is stored separately from the item, so the item's own metadata (title, folder, tags, owner, access) lives on the drive item and is not repeated here. The body is exchanged as GitHub-Flavored Markdown, with a sanitised-HTML projection available on demand for the colours, highlights, alignment and mentions Markdown cannot express. Access is inherited whole from the owning drive item: a caller who may read that item may read its body, and a caller who may edit it may write one.

Used by

GETList document bodies/drive-documentsDriveDocumentList
POSTCreate a document body/drive-documentsDriveDocument
GETRead a document body/drive-documents/{drive_document}DriveDocument
PATCHWrite a document body/drive-documents/{drive_document}DriveDocument

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Id of the document body, not of the drive item it belongs to. The two are numbered separately.

drive_item_idinteger

The drive item this body belongs to. Set on create and immutable afterwards; read the item itself from GET /api/v2/drive-items/{drive_item}.

contentmarkdown or nullDetail only

The document body as GitHub-Flavored Markdown: headings, lists, task lists (- [ ]), tables, code fences, links and images all survive. Detail-only: pass ?view=detail to get it on the collection. Markdown cannot express text colours, highlights, alignment or @mentions, so read ?include=content_html first if the document may contain them: a read of content followed by a PATCH of it discards all four permanently.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync. Typing in the collaborative editor moves this, not the drive item's own updated_at.

content_htmlhtml or nullOn request

The same document as sanitised HTML, preserving the text colours, highlights, alignment and @mentions Markdown cannot carry. Mention spans round-trip unchanged; constructing a new one is out of scope for v2.0.

Variants

DriveDocumentList 6 fields

What a collection returns, and what ?view=summary returns on a single record.

Leaves out: content

DriveDocumentLinks 1 field

The links object on this resource.

Keys: self