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": "a98eee6b-a12b-478f-8f58-7a5941069e4a",
"Asset": {
"AssetId": "f28b1432-2387-4344-952c-d690ecb57297",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "223889b3-c759-485a-a059-1d0999ccb0d8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9ff15af8-9fbe-4950-9fe0-3598ce00ca2b",
"CreateDate": "2026-02-05T16:58:26.2921976-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-05T16:58:26.2921976-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7243bd61-49d5-42e5-8c72-98be53b7b8aa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-05T16:58:26.2921976-08:00",
"MeasurementValueNeededDate": "2026-02-05T16:58:26.2921976-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4886cc64-408b-48a5-a307-e7d9b41ad82e",
"CreateDate": "2026-02-05T16:58:26.2921976-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T16:58:26.2921976-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-05T16:58:26.2921976-08:00",
"MeasurementValueNeededDate": "2026-02-05T16:58:26.2921976-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5fafce5a-97eb-4082-8262-98ac528e6003",
"CreateDate": "2026-02-05T16:58:26.2921976-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-05T16:58:26.2921976-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "a5c2a3f0-3bb9-4565-9004-ee859d0c2c0a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9d645718-ba8c-4732-8cf4-653cdc8a335e",
"CreateDate": "2026-02-05T16:58:26.2921976-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-05T16:58:26.2921976-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-05T16:58:26.2921976-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e3d6aec5-b0f1-4a75-923c-9edab46c377c",
"CreateDate": "2026-02-05T16:58:26.2921976-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-05T16:58:26.2921976-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": "c04e8a6d-23dd-4b7f-9e36-7777c0d7ed76",
"Asset": {
"AssetId": "1bf8fcf7-3a98-4ee1-a807-af4b4b11c430",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "77ec5741-df5f-4b8c-8320-1f09ef33d8bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e50f424d-c84a-4133-bc94-80a47977a970",
"CreateDate": "2026-02-05T16:58:26.3234009-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-05T16:58:26.3234009-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b0d716ad-5240-43a7-be0d-9acd86213780",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-05T16:58:26.3234009-08:00",
"MeasurementValueNeededDate": "2026-02-05T16:58:26.3234009-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bcca281f-25b2-48ff-b84f-c7c376539cfc",
"CreateDate": "2026-02-05T16:58:26.3234009-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T16:58:26.3234009-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-05T16:58:26.3234009-08:00",
"MeasurementValueNeededDate": "2026-02-05T16:58:26.3234009-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d11acafe-70c4-4ce6-905b-e7bd73de47dd",
"CreateDate": "2026-02-05T16:58:26.3234009-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-05T16:58:26.3234009-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "cb2f5f82-d7dd-4de6-b348-83842efae1a6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2ea1a5e2-4da7-489c-a170-762ecb605697",
"CreateDate": "2026-02-05T16:58:26.3234009-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-05T16:58:26.3234009-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-05T16:58:26.3234009-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e3b0bafe-f3a4-4e3a-933e-aa4efa6ac583",
"CreateDate": "2026-02-05T16:58:26.3234009-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-05T16:58:26.3234009-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}