/
File Notes
File Notes
- Aaron Pettit (Unlicensed)
- Steve Randall
- Terra Yi (Unlicensed)
Owned by Aaron Pettit (Unlicensed)
The File Notes resource represents file notes on actions and action documents.
Resource Properties
| Scope Parameter | filenotes |
|---|---|
| Location | /filenotes |
| Methods | GET POST PUT DELETE |
| Default Page Size | 50 |
| Max Page Size | 200 |
| Default Includes | None |
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|---|---|---|---|---|---|
| enteredTimestamp | The time the file note was created. | timestamp | true | default | read-only | |
| text | The file note text content. | string | false | default | ||
| enteredBy | The name of the user who entered the file note | string (100) | false | additional | read-only | |
| source | string (25) | false | additional | |||
| noteTimestamp | timestamp | false | additional | |||
| action | The Action that the file note belongs to. | string | true | link | ||
| document | The ActionDocument the file note relates to. | string | false | link | ||
| participant | The Participant that created the file note. | string | false | link | read-only |
Link Templates
| Identifier | Resource | Location Template |
|---|---|---|
| filenotes.action | actions | /actions/{filenotes.action} |
| filenotes.document | actiondocuments | /actiondocuments/{filenotes.document} |
| filenotes.participant | participants | /participants/{filenotes.participant} |
Related content
Action Documents
Action Documents
More like this
Action Types
Action Types
More like this
Participants
Participants
Read with this