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": "a7fe32ed-d118-4851-a3e8-d6ab1f0f62a7",
"Asset": {
"AssetId": "975d64ee-c565-48d6-bde8-3093fb5c6c0e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d1e67079-5205-497d-b93f-2585b19730a3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2df651a8-2932-489b-a0ca-808f853db0b5",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ae219c10-2afa-4bf7-91fb-7a22deea8247",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-05T00:34:05.855533-08:00",
"MeasurementValueNeededDate": "2025-11-05T00:34:05.855533-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c1e9b5d4-dfd3-4103-a0fb-2d6cddfc6229",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-05T00:34:05.855533-08:00",
"MeasurementValueNeededDate": "2025-11-05T00:34:05.855533-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9116ddd9-3de5-4f02-964d-39799a016648",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "bda86120-a770-450e-afc2-9ebe4caf63bf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "03d350c7-06de-43d2-80a7-ba91daca9ccd",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-05T00:34:05.855533-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d6dbb53b-8f8b-4b5b-b432-1509f9457ce2",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08: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": "3613649f-bd16-442d-995a-69445aa4a4ad",
"Asset": {
"AssetId": "a0eba92b-ff61-4021-ab80-c32044d32e20",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5071cdb5-adf7-4dd6-a7f2-6d41ea5751e4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e19a0aa5-6b90-4a64-9820-4942b5301303",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ab891c55-407c-4c82-8874-532a71997b92",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-05T00:34:05.855533-08:00",
"MeasurementValueNeededDate": "2025-11-05T00:34:05.855533-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8cd76d33-c134-4466-93d5-f7296786c65e",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-05T00:34:05.855533-08:00",
"MeasurementValueNeededDate": "2025-11-05T00:34:05.855533-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3ec1f051-e056-4ba8-ae25-63e41587ac10",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "99cc7851-35cc-47c1-b80f-5150e942f932",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c1773a41-7d0c-43df-b401-9f2b17debf87",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-05T00:34:05.855533-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1050005c-befc-4662-b36b-e1da2d2af6b8",
"CreateDate": "2025-11-05T00:34:05.855533-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-05T00:34:05.855533-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}