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": "711feea1-3973-4914-9004-76cf96323275",
"Asset": {
"AssetId": "c039b315-2dee-4de8-b622-88877025bb0b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "cfa994c4-b77f-4d0c-bb29-b67da56be7b5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "96cea779-f81b-43fa-87cc-8d36a42c0c81",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "342793fa-419d-4326-a0dc-4581ecea6130",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:25:16.2422366-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:25:16.2422366-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7625cefb-7581-441c-ab77-cc3d6addbb8c",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-25T14:25:16.2422366-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:25:16.2422366-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f66b65f2-6831-418a-b91c-c7a53f263831",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "4ca5ebee-fdfc-4bab-80dc-8e5c252e09d7",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1bc37744-7d58-45cb-b617-9682e7ac3cf3",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-25T14:25:16.2422366-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6e865bd1-7fcb-4e29-bdc6-aaf9e5ade156",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-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": "abdad64f-7ad0-43d3-bcec-f270994efa51",
"Asset": {
"AssetId": "c762e699-7364-49f9-a15d-d53d25d53a40",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5a349687-06ea-4738-8b9b-684afe1bcc30",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b0e94a03-bff7-4c72-989a-5debfba2a77a",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "cd10f637-1b81-4061-bdfe-e2a4c1e68c39",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-25T14:25:16.2422366-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:25:16.2422366-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e415cc02-0cfd-445c-a9ec-75980bedafb0",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-25T14:25:16.2422366-07:00",
"MeasurementValueNeededDate": "2026-06-25T14:25:16.2422366-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f51d544c-82e5-48a3-af26-f5f397105582",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "5e632720-d74c-4f71-bdf7-011de598f90a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "883215cb-4237-4b8d-82ef-2055616c0a39",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-25T14:25:16.2422366-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6e889afe-4549-4d44-a5d4-d3d9b067e0fb",
"CreateDate": "2026-06-25T14:25:16.2422366-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-25T14:25:16.2422366-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}