POST Notes
Creates a new note.
Request Information
URI Parameters
None.
Body Parameters
The note to create. NoteId should not be filled in.
Note| Name | Description | Type | Additional information |
|---|---|---|---|
| NoteId | globally unique identifier |
None. |
|
| Asset | Asset |
None. |
|
| NoteCategory | NoteCategory |
None. |
|
| EffectiveDate | date |
None. |
|
| NoteHTML | string |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"NoteId": "7a97cfc7-e35c-43a8-8868-77c820b12359",
"Asset": {
"AssetId": "7fc40880-a9e2-4a07-895a-2e5a6cca1c00",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "113891d9-9685-40cd-a84b-7082f8afe4ab",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7fed36e5-af22-418f-a513-760caef9b8e1",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c7f28b94-6fd3-4a6e-b61d-d5a8e556f2b3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T21:46:59.4058654-07:00",
"MeasurementValueNeededDate": "2025-09-17T21:46:59.4058654-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9a55c04d-097f-478f-ae08-6ee719906a83",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-17T21:46:59.4058654-07:00",
"MeasurementValueNeededDate": "2025-09-17T21:46:59.4058654-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7433e1bc-9522-41e7-b4aa-4db6d797e8c4",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1a0fe6e4-9776-4074-aa53-55c8872ed85d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "df947d0d-38be-4550-950f-1c252a49dc18",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-17T21:46:59.4058654-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "edcd7829-ed83-4f2f-a51c-a3b7385735ca",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 5"
}
Response Information
Resource Description
On success, the created note.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"NoteId": "1b766046-48de-4018-8a5e-3be932ec0174",
"Asset": {
"AssetId": "cb69046a-d589-44da-8535-5fba4e912810",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "238394b1-ce18-4608-baa0-718fd2df47e9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "80a44efc-ba53-4045-aaee-ced8fd222976",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c6f7e8c3-459c-4944-b564-75075f5f9242",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T21:46:59.4058654-07:00",
"MeasurementValueNeededDate": "2025-09-17T21:46:59.4058654-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e4cb0dea-4d1b-44b9-a32c-42f3af8fb5fa",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-17T21:46:59.4058654-07:00",
"MeasurementValueNeededDate": "2025-09-17T21:46:59.4058654-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c4dd1b2f-bf43-4bbc-9dea-7a7698c9f04b",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1f3d7851-5eee-4f16-9f4f-317769d5912e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c2a0dd8b-5f71-4a41-9e46-98312570d1d0",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-17T21:46:59.4058654-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e238eeb7-998c-45ee-bd77-ea46c8788281",
"CreateDate": "2025-09-17T21:46:59.4058654-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T21:46:59.4058654-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}