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": "ef8689d5-c97d-4f05-a931-989fe1e2996a",
"Asset": {
"AssetId": "76d37411-1b50-4760-83fb-e4aefa29a8bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "741ce813-952c-49a0-a390-0fb8c1440c64",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "85c9c041-1358-45c1-aafe-0f99d465996e",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4a84e310-0ffc-4ca7-be89-3dd5effcb3a0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T15:18:45.6891146-07:00",
"MeasurementValueNeededDate": "2025-06-30T15:18:45.6891146-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f47a54b4-af65-4b05-8f5f-91d961203f80",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-30T15:18:45.6891146-07:00",
"MeasurementValueNeededDate": "2025-06-30T15:18:45.6891146-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "22caca42-2f4b-4894-9515-d6e63e568a60",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "191eaedf-f2b0-4994-9b08-4223206994ff",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "685a58dd-499e-4489-bc46-f1c5a258981c",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T15:18:45.6891146-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c7d2e32a-0faf-43dc-b083-5f2d669ebcec",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-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": "d50653ee-bfd2-4f25-a8db-1795e5de1903",
"Asset": {
"AssetId": "3707018c-e295-40ff-8cd3-38a20fa3e7eb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0e5601df-3705-4225-bee7-d4154ba3231a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2baa965f-276a-4db1-a1a4-2b6421cba627",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3e71e486-dfca-40a1-81c6-29e845d3dfe2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T15:18:45.6891146-07:00",
"MeasurementValueNeededDate": "2025-06-30T15:18:45.6891146-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c069962e-e3dd-481e-af75-d73c41aa7819",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-30T15:18:45.6891146-07:00",
"MeasurementValueNeededDate": "2025-06-30T15:18:45.6891146-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5ab65c88-60bd-48cd-b959-a71f2957add9",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "abe426e1-e3f1-492e-a30e-93135d2906bd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1fc33857-3164-4b34-a8fc-4a69b182f3f2",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T15:18:45.6891146-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b5c36708-9946-43bb-9419-4663c7ac4cd2",
"CreateDate": "2025-06-30T15:18:45.6891146-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T15:18:45.6891146-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}