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": "4ae25794-62ac-4e69-8549-2d9e9887cc13",
"Asset": {
"AssetId": "c711b1ce-d4f8-4e21-bb94-a978f79aaac5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "62e64f8b-6ad1-4d05-9839-f11b5bd9a15f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2aec71b4-cadc-4cfd-9eee-1979e1573d84",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "964f51a5-f68d-454e-b8eb-6609051c770d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-12T11:14:12.4322719-07:00",
"MeasurementValueNeededDate": "2026-08-12T11:14:12.4322719-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "56a0b54b-6921-459e-ae42-a6e67f563f34",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-12T11:14:12.4322719-07:00",
"MeasurementValueNeededDate": "2026-08-12T11:14:12.4322719-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "750609c6-8249-4ef1-895d-5eb13ba0e836",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "8e64e612-72a6-4ae6-876d-86e2efb9993b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8fb99c00-a08b-4b99-8840-d31c33b21845",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-12T11:14:12.4322719-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b0e86d47-cb60-4795-9dba-687fa5c49a55",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-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": "a4f674fd-8bce-4e37-a21d-0e5551a2e66b",
"Asset": {
"AssetId": "47a11ea1-3119-4456-a568-2429f2e1b263",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "10db5256-a83c-4572-8e5b-2aaa7d0ef26f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0a327219-5b43-4c4d-a579-489b1afb39bd",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0d490a6f-9817-4d6a-87ab-2c8c0bd19b25",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-12T11:14:12.4322719-07:00",
"MeasurementValueNeededDate": "2026-08-12T11:14:12.4322719-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "356b41f8-10b1-493e-acc9-ef1b85e74417",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-12T11:14:12.4322719-07:00",
"MeasurementValueNeededDate": "2026-08-12T11:14:12.4322719-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "80cd0a13-a562-4e97-8b52-81298def6ed1",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "d70e03e5-96ff-4dc2-aaba-a2c57f8955ac",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e07245ba-b982-4fb6-b07d-b82874ce9291",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-12T11:14:12.4322719-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5aea97a6-f662-4bef-a896-63173b971c6d",
"CreateDate": "2026-08-12T11:14:12.4322719-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-12T11:14:12.4322719-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}