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": "1d21e2fe-3c29-40fd-957d-50783bc923f3",
"Asset": {
"AssetId": "47eaeb69-4a25-44e9-b8e3-e025d95adb3a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f70edddd-cdc8-4708-8e0e-cdd7cc8aa53c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e1088814-6473-421e-98c6-af78584c5088",
"CreateDate": "2026-06-13T09:59:39.4062699-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T09:59:39.4062699-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fb672637-a84e-4e63-8efd-184825778ffa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T09:59:39.4062699-07:00",
"MeasurementValueNeededDate": "2026-06-13T09:59:39.4062699-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0ea8a9db-6ecc-4f05-8523-0eae00ec1299",
"CreateDate": "2026-06-13T09:59:39.4062699-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T09:59:39.4062699-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-13T09:59:39.4062699-07:00",
"MeasurementValueNeededDate": "2026-06-13T09:59:39.4062699-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "19c47535-ea03-4b64-a91a-a0879088145f",
"CreateDate": "2026-06-13T09:59:39.4062699-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T09:59:39.4062699-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e981a557-a954-468a-bec2-1dca41303677",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0016932d-59ef-4a58-87e0-15a1d8259931",
"CreateDate": "2026-06-13T09:59:39.4062699-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T09:59:39.4062699-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-13T09:59:39.4062699-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e59870e7-a3b0-4d10-8db0-becf5ede92b0",
"CreateDate": "2026-06-13T09:59:39.4062699-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T09:59:39.4062699-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": "57d3885b-4a09-4508-af40-b1dea51f4a28",
"Asset": {
"AssetId": "bb5eb260-b493-4a15-b539-acf6db5e2f3e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6eecda5c-baae-4fc2-8a88-1abf5b835894",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b154e5e3-ee3a-4d46-b2ef-0b6a148acf85",
"CreateDate": "2026-06-13T09:59:39.4219413-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T09:59:39.4219413-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "56653fb3-0ddc-4990-91cc-13e10677436d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T09:59:39.4219413-07:00",
"MeasurementValueNeededDate": "2026-06-13T09:59:39.4219413-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a61ea2f1-b873-4bbe-bdff-ad0f8d9f5413",
"CreateDate": "2026-06-13T09:59:39.4219413-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T09:59:39.4219413-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-13T09:59:39.4219413-07:00",
"MeasurementValueNeededDate": "2026-06-13T09:59:39.4219413-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1bab8794-47fe-4f25-a240-3cbc40bda3fe",
"CreateDate": "2026-06-13T09:59:39.4219413-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T09:59:39.4219413-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "63e187b8-50b8-4667-9511-231001b12621",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "25b80342-f67a-467b-b8d0-c7533775be7c",
"CreateDate": "2026-06-13T09:59:39.4219413-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T09:59:39.4219413-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-13T09:59:39.4219413-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4f65d6af-6c6a-4418-8269-072c0d5c1329",
"CreateDate": "2026-06-13T09:59:39.4219413-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T09:59:39.4219413-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}