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": "07993d85-64f4-482a-8240-97a44be7e907",
"Asset": {
"AssetId": "29a3eb7b-74f4-431f-a6d3-bd122ade9d12",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f94b3418-7fcc-4d3e-b6ba-d5b98301db9c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4a49cbc5-eaf7-4ca6-8a7a-b5857976ab65",
"CreateDate": "2025-06-25T06:01:52.4563425-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-25T06:01:52.4563425-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f039195d-fbeb-4389-9f82-096b535061dd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-25T06:01:52.4563425-07:00",
"MeasurementValueNeededDate": "2025-06-25T06:01:52.4563425-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "400e1ac6-29d6-45e1-8ac8-a239841c20b4",
"CreateDate": "2025-06-25T06:01:52.4563425-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-25T06:01:52.4563425-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-25T06:01:52.4563425-07:00",
"MeasurementValueNeededDate": "2025-06-25T06:01:52.4563425-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6c79791a-3421-4107-8442-ef50d5b9687d",
"CreateDate": "2025-06-25T06:01:52.4563425-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-25T06:01:52.4563425-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "bce834d0-9739-41e7-abb4-e2a247afb8d5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5ee86d34-58b2-4f09-b997-ba7bcae958d3",
"CreateDate": "2025-06-25T06:01:52.4563425-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-25T06:01:52.4563425-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-25T06:01:52.4563425-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d8bdedf2-f116-4495-acf9-d1fde5cd42d4",
"CreateDate": "2025-06-25T06:01:52.4563425-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-25T06:01:52.4563425-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": "08b32606-563e-4690-89c5-9d62e6c1cb3d",
"Asset": {
"AssetId": "b4116dd8-12df-4601-b181-92beddd65d77",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8eb0cc20-0698-4fe3-ab85-ed89859ae87e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "458e7cf2-e506-49e1-8e66-fbefe25ccf2b",
"CreateDate": "2025-06-25T06:01:52.471976-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-25T06:01:52.471976-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3a773c40-727d-4aad-84d9-d83ec83a1f37",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-25T06:01:52.471976-07:00",
"MeasurementValueNeededDate": "2025-06-25T06:01:52.471976-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "887e8d73-bb7a-494a-b8f1-9046559f2cea",
"CreateDate": "2025-06-25T06:01:52.471976-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-25T06:01:52.471976-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-25T06:01:52.471976-07:00",
"MeasurementValueNeededDate": "2025-06-25T06:01:52.471976-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "45aff0f5-9040-4b3d-a0b5-412c60481d7e",
"CreateDate": "2025-06-25T06:01:52.471976-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-25T06:01:52.471976-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "cbec64f3-7572-4104-a838-aecb018217de",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7b28ef31-116e-465d-8a7f-ff6478f50961",
"CreateDate": "2025-06-25T06:01:52.471976-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-25T06:01:52.471976-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-25T06:01:52.471976-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "be49e866-7e4d-4be0-af15-c778577e13ca",
"CreateDate": "2025-06-25T06:01:52.471976-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-25T06:01:52.471976-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}