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": "f0c00655-bb2f-4195-a84c-d8b76c4cc7aa",
"Asset": {
"AssetId": "273d65e4-9c5d-4901-b9dd-0dc6f9c1ac97",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2fe98bd1-6f71-4c4d-9535-fdb95eb31e1e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "02db28c7-f5ad-4ed1-be95-71c61606976f",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1965bf48-dc1c-4a19-93bf-320e99ff2875",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-31T03:13:01.8750699-07:00",
"MeasurementValueNeededDate": "2025-07-31T03:13:01.8750699-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c8c4e9de-442e-4bea-bc46-23d65ffba812",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-31T03:13:01.8750699-07:00",
"MeasurementValueNeededDate": "2025-07-31T03:13:01.8750699-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "77347478-0419-4c6c-bfdf-d2fd99349333",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "fad40b68-7ec0-46eb-9682-f91e0113179b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cf6a131f-bb75-4492-aba6-111279f051c3",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-31T03:13:01.8750699-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7bb886e7-c3e3-4965-a787-77b75dd96cad",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-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": "7ae6f5f5-a157-4c56-b512-53626ae4d0d2",
"Asset": {
"AssetId": "42149d21-c318-4c29-8966-b2abe618fa9c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "61d263c4-5963-4b58-be74-343ad5eab75a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bdab03b5-4488-499e-adb6-b8849d965e74",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c7bb7626-4964-4bab-af5c-53f0dc82d4c1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-31T03:13:01.8750699-07:00",
"MeasurementValueNeededDate": "2025-07-31T03:13:01.8750699-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ca626664-d893-4b08-b24f-34ef8a9c2722",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-31T03:13:01.8750699-07:00",
"MeasurementValueNeededDate": "2025-07-31T03:13:01.8750699-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "64720e40-35d3-4313-aea6-5d47500e6a61",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1b2177a2-e377-4921-9dff-6093e67c8520",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9cfd6fda-4db7-4b0b-850a-d40d916a600b",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-31T03:13:01.8750699-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "08a1b5b8-f64c-4f6b-b69d-d1907741054e",
"CreateDate": "2025-07-31T03:13:01.8750699-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-31T03:13:01.8750699-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}