The information in this document is currently in BETA and subject to change.
The Action Documents resource represents documents stored in an action.
Resource Properties
| Scope Parameter | scratchnotes |
|---|---|
| Location | /scratchnotes |
| 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 |
|---|---|---|---|---|---|---|
| timestamp | The name of the document. | string | false | default | read-only | |
| text | When the document last modified. | number | true | default | ||
| status | The status of the scratch note. | string | false | default | read-only | |
| participant | The Participant that the scratch note belongs to. | string | false | link | read-only |
Link Templates
Identifier | Resource | Location Template |
|---|---|---|
| scratchnotes.participant | participants | /participants/{scratchnotes.participant} |
Errors
Code | Field | Condition |
|---|---|---|
| AD-01 | folder | The value of the status attribute must be either "Active", "Inactive", "Closed" or "Template" |
| AD-02 | folder | The value of the priority field is numeric. |
| AD-03 | status | Cannot modify this document as it is currently checked out. |