POST api/v1/NeedNotes
Creates a new Need Note
Request Information
URI Parameters
None.
Body Parameters
NeedNoteCreateModel| Name | Description | Type | Additional information |
|---|---|---|---|
| NeedId | globally unique identifier |
Required |
|
| AssignmentId | globally unique identifier |
None. |
|
| Note | string |
String length: inclusive between 0 and 1000 |
|
| ActionId | integer |
None. |
|
| DepartmentShiftId | integer |
None. |
|
| CreatedDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"NeedId": "e1335434-93d6-4f8b-ae10-b18fa73b20e8",
"AssignmentId": "5b672b9b-9fc1-4d79-92e5-9bbf9045c505",
"Note": "sample string 2",
"ActionId": 1,
"DepartmentShiftId": 1,
"CreatedDate": "2026-08-28T17:12:46.4363585-05:00"
}
Response Information
Resource Description
ApiResponseModelOfNeedNoteModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfNeedNoteModel |
None. |
|
| Errors | Collection of string |
None. |
|
| Warnings | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"PageSize": 1,
"Page": 2,
"TotalPages": 3,
"TotalResults": 4,
"Results": {
"NeedNoteID": "aa14f1c0-3018-495e-9250-392cd32f2586",
"NeedID": "f85ddbaa-515a-448b-bb49-7b4394668f05",
"AssignmentID": "fa12ed55-c3f4-4a47-b0e3-e2a0755cb184",
"CreateDate": "2026-08-28T17:12:46.4519934-05:00",
"CreateUser": "sample string 4",
"CreateApp": "sample string 5",
"Note": "sample string 6",
"Version": "QEA=",
"ActionID": 1,
"Action": "sample string 7",
"DepartmentShiftID": 1,
"ShiftCode": "sample string 8"
}
},
"Errors": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
]
}