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": "7d9b19a0-283e-4d54-b3dc-6655607fad84",
"Asset": {
"AssetId": "d57a4454-c295-4043-87f5-e36bf3798b11",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "664a059a-d468-469c-b32f-97b844dab0af",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f980efe1-3c52-49d9-9e65-f2ab7b3fc70b",
"CreateDate": "2025-09-17T01:43:54.0917268-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T01:43:54.0917268-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "190b5b18-4bc5-4beb-9c22-6d7505426532",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T01:43:54.0917268-07:00",
"MeasurementValueNeededDate": "2025-09-17T01:43:54.0917268-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8cb7e361-c3b9-48fc-9ba9-0ee63cf7d563",
"CreateDate": "2025-09-17T01:43:54.0917268-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T01:43:54.0917268-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-17T01:43:54.0917268-07:00",
"MeasurementValueNeededDate": "2025-09-17T01:43:54.0917268-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5d2da79b-6d5d-4762-a999-c096f2264c20",
"CreateDate": "2025-09-17T01:43:54.0917268-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T01:43:54.0917268-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "47d2f70d-5461-4820-a4c7-788ea19fbea3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1be8128b-5cee-440c-a0c3-fd34028bb673",
"CreateDate": "2025-09-17T01:43:54.0917268-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T01:43:54.0917268-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-17T01:43:54.0917268-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8008099b-975d-4951-8363-d29a27cec615",
"CreateDate": "2025-09-17T01:43:54.0917268-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T01:43:54.0917268-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": "53aba3b0-a66a-4853-b42f-a329d85c67a3",
"Asset": {
"AssetId": "14466b4d-1561-49db-bc3d-3fad81174121",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e63610e4-86e9-4c0f-840b-0a96ac8a5a0b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e5515913-d062-43e5-b041-3378b0c6a870",
"CreateDate": "2025-09-17T01:43:54.1072998-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T01:43:54.1072998-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e263b166-6a75-4291-8f65-e9ba486b90a0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T01:43:54.1072998-07:00",
"MeasurementValueNeededDate": "2025-09-17T01:43:54.1072998-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "186980a0-cebf-4e3e-b48e-ee437ab171d7",
"CreateDate": "2025-09-17T01:43:54.1072998-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T01:43:54.1072998-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-09-17T01:43:54.1072998-07:00",
"MeasurementValueNeededDate": "2025-09-17T01:43:54.1072998-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0cf9bb0d-1acb-4773-bed5-bceb743e889b",
"CreateDate": "2025-09-17T01:43:54.1072998-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T01:43:54.1072998-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "821c2a2d-bf9c-4b78-94c4-9fa27b287642",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cf861703-7da8-499a-9af8-b544e85d7c92",
"CreateDate": "2025-09-17T01:43:54.1072998-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T01:43:54.1072998-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-17T01:43:54.1072998-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e7deb811-7f73-4283-9a62-025d75e3bcfb",
"CreateDate": "2025-09-17T01:43:54.1072998-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-17T01:43:54.1072998-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}