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": "d28cc0ab-b0b5-4568-b375-f72d65f8cdf4",
"Asset": {
"AssetId": "66cf195b-3554-4e30-b123-b33cf5b1b0ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b307c9e1-ce58-446f-b067-151e7f7ee9bf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "93d99d24-b2a8-43df-98b5-2111ef1e1f68",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4d07b0d8-224d-4491-bc06-e3d8a930764f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-30T13:50:58.1962553-07:00",
"MeasurementValueNeededDate": "2025-04-30T13:50:58.1962553-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ac4dda43-4082-478e-846c-d63b487d8af3",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-30T13:50:58.1962553-07:00",
"MeasurementValueNeededDate": "2025-04-30T13:50:58.1962553-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5d22f5c2-3ed7-4b86-859b-80314f74384d",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "7b286755-e6a8-467f-9893-b1f53600cd08",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5d19994e-10bf-4933-8f7d-6d5a993a2111",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-30T13:50:58.1962553-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "086b9b43-5435-416a-a81f-501e8eefbe49",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-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": "0e222d41-3584-48f4-9b4a-9938e0805ef4",
"Asset": {
"AssetId": "7ad72b62-502d-4f53-97dc-b0d81c4b9f44",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d6ae2c98-d30d-4dcd-a73d-e1e8ceda217a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6ba9d137-7bfc-425b-a346-17e654262f95",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ba259090-af61-464e-afe4-43ca595db892",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-30T13:50:58.1962553-07:00",
"MeasurementValueNeededDate": "2025-04-30T13:50:58.1962553-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "86a9a52d-44e2-478a-8fb1-b708b2822edd",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-30T13:50:58.1962553-07:00",
"MeasurementValueNeededDate": "2025-04-30T13:50:58.1962553-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1f1df672-1d70-4cfe-a2c2-4f285671e094",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "5de65a6f-3e09-49c3-8404-b497bf0f999b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9a1bd963-ae1d-4bb0-9c9d-d443c3bec9b0",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-30T13:50:58.1962553-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d83657e2-9b5c-4957-bd2a-7325a837f7ce",
"CreateDate": "2025-04-30T13:50:58.1962553-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-30T13:50:58.1962553-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}