NoteDto
A note attached to an entity such as a client or task
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The unique code for this note |
The unique code for this note | ||
| text | string | The note text |
The note text | ||
| date | string | The date/time of the note |
The date/time of the note | ||
| noteFromUser | CodeAndNameDto | |
| pinnedLevel | integer | The pinned level for ordering pinned notes |
The pinned level for ordering pinned notes | ||
| createdDate | string | When the note was created |
When the note was created | ||
| updatedDate | string | When the note was last updated |
When the note was last updated | ||
| stepNumber | integer | The workflow step number if this is a step-level note (null for task-level notes) |
The workflow step number if this is a step-level note (null for task-level notes) | ||
| groupNumber | integer | The workflow group number if this is a step-level note (null for task-level notes) |
The workflow group number if this is a step-level note (null for task-level notes) | ||
| stepName | string | The name of the workflow step if this is a step-level note (null for task-level notes) |
The name of the workflow step if this is a step-level note (null for task-level notes) | ||
JSON Example
{
"code": "string",
"text": "string",
"date": "2024-01-01T00:00:00Z",
"noteFromUser": {
"code": "string",
"name": "string"
},
"pinnedLevel": 0
}
Used By Operations
-
POST
Create Note for Client
/tenants/{tenant}/clients/{client}/clientnote
-
GET
Get Note for Client
/tenants/{tenant}/clients/{client}/clientnote/{code}
-
PUT
Update Note for Client
/tenants/{tenant}/clients/{client}/clientnote/{code}
-
POST
Create Note
/tenants/{tenant}/tasks/{taskCode}/taskitemnote
-
GET
Get Note by Code
/tenants/{tenant}/tasks/{taskCode}/taskitemnote/{code}
-
PUT
Update Note
/tenants/{tenant}/tasks/{taskCode}/taskitemnote/{code}
-
POST
Create Note for Workflow Step
/tenants/{tenant}/tasks/{taskCode}/groups/{groupNumber}/steps/{stepNumber}/notes
-
GET
Get Note by Code
/tenants/{tenant}/tasks/{taskCode}/groups/{groupNumber}/steps/{stepNumber}/notes/{code}
-
PUT
Update Note for Workflow Step
/tenants/{tenant}/tasks/{taskCode}/groups/{groupNumber}/steps/{stepNumber}/notes/{code}