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": "450eba22-fef1-4f41-a0f7-46612e153dcb",
"Asset": {
"AssetId": "fdfb7c91-b81a-41f3-b371-a6275900750b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3a2b554a-55b3-4d3d-8f9d-be3abca561f1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "544b2404-f3f8-4482-956a-a3537182f6e0",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "45279289-d80e-43e8-a208-a6dfd9b177b6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-05T09:36:26.2246917-07:00",
"MeasurementValueNeededDate": "2026-09-05T09:36:26.2246917-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ae1ceafa-d0b3-43ba-998b-c92328448201",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-05T09:36:26.2246917-07:00",
"MeasurementValueNeededDate": "2026-09-05T09:36:26.2246917-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3fdd3940-164d-429c-9f49-7ade6e8334fc",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "a21320aa-fcdd-4cc3-89bf-b27c79536e1e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "148ebfaf-2a3f-46d3-a3b3-2f77c36ec9e9",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-05T09:36:26.2246917-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "457b2319-69b9-4577-9ee7-ec75f210eae8",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-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": "9db5c10d-0512-4d1b-94a9-573d829d88b7",
"Asset": {
"AssetId": "5a5671b6-09f2-4625-9f82-8a55c059485d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "61800ef6-f9d0-4328-bcd9-91b48fd04eea",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "89eb3aad-4877-49b6-972a-f3ef46589fb1",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4d803167-950a-4f68-b98b-a09e91967ea1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-05T09:36:26.2246917-07:00",
"MeasurementValueNeededDate": "2026-09-05T09:36:26.2246917-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "46848028-145c-4375-a42a-5abb650c17a9",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-05T09:36:26.2246917-07:00",
"MeasurementValueNeededDate": "2026-09-05T09:36:26.2246917-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "60e53aa8-ed58-4387-b17c-d66f30003a54",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "851e29a0-abe2-43cd-b0ba-9e73615dd095",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6629c8e3-2872-4dd8-a73c-e3d9bb7251c7",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-05T09:36:26.2246917-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5dc412ce-44cc-439f-b676-765ee98b5dc7",
"CreateDate": "2026-09-05T09:36:26.2246917-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-05T09:36:26.2246917-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}