The information in this document is currently in BETA and subject to change.
The Scratch Notes resource represents notes on the scratch pad.
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 time that the scratch note was created | string | false | default | ||
| text | The content of the scratch note. | 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} |