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

Note

Note

A free-text note attached to a project, a customer or a work item: the running commentary plnnrly shows in a record's Notes sub-page.

View as Markdown
Summary view
NoteList, 11 fields. What a list returns by default.
Detail view
Note, 11 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

The body is rich text from the editor, sanitised on the way out. A note is read through the record it hangs off, and written under that record's own note permission: projects::notes, customers::update or project_management::manage_work_items by parent type.

Used by

GETList notes/notesNoteList
POSTCreate a note/notesNote
GETRead a note/notes/{note}Note
PATCHUpdate a note/notes/{note}Note

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

Unique identifier.

contenthtml

Note body as rich-text HTML, sanitised on read.

order_columnintegerServer-assigned

Sort position within the parent record. Assigned by the server; reordering is not exposed in v2.0. Positions are not counted per parent, so the sequence is effectively creation order across the whole organisation.

user_idinteger or nullServer-assigned

Author of the note. Always the authenticated user at create time; null where the author has since been deleted.

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

Creation timestamp.

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

Last-write timestamp; use for incremental sync.

notable_typestring

The kind of record notable points at; it says which branch of notable applies.

projectcustomerwork_item

New values may be added.

notable_idinteger

The id of the record notable points at.

notableRef or ProjectSummary or CustomerSummary or WorkItemSummary

The project, customer or work item this note is attached to.

Which form you get depends on notable_type.

project
ProjectSummary
customer
CustomerSummary
work_item
WorkItemSummary
userRef or UserSummary or null

Author of the note.

Variants

NoteList 11 fields

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

The same fields as the detail object.

NoteLinks 1 field

The links object on this resource.

Keys: self

Polymorphic fields

notableWhich form you get depends on notable_type.