Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

The information in this document is currently in BETA and subject to change.


The File Notes resource represents file notes on actions and action documents.


Resource Properties
Scope Parameterfilenotes
Location/filenotes
MethodsGET POST PUT DELETE
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
enteredTimestampThe time the file note was created.timestamptruedefaultread-only
textThe file note text content.stringfalsedefault

enteredByThe name of the user who entered the file notestring (100)falseadditionalread-only
source
string (25)falseadditional

noteTimestamp
timestampfalseadditional

actionThe Action that the file note belongs to.stringtruelink

documentThe ActionDocument the file note relates to.stringfalselink

participantThe Participant that created the file note.stringfalselinkread-only


Link Templates
IdentifierResourceLocation Template
filenotes.actionactions/actions/{filenotes.action}
filenotes.documentactiondocuments/actiondocuments/{filenotes.document}
filenotes.participantparticipants/participants/{filenotes.participant}
  • No labels