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": "b6c9068c-e654-4186-a7bb-7e579ef7c5a1",
"Asset": {
"AssetId": "d5469138-28e5-49b2-9010-ac04d883a0c0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "149f5b77-e560-4ea5-a51f-66be6dad41cc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "da9515f3-4bc6-4750-9494-fc0a9985a9c5",
"CreateDate": "2026-08-09T23:40:55.5382186-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:40:55.5382186-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "91653e6b-c3d5-4ec0-b4e2-e61ff5205792",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:40:55.5382186-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:40:55.5382186-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b2216905-9a5b-4124-a893-46e440858338",
"CreateDate": "2026-08-09T23:40:55.5382186-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:40:55.5382186-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-09T23:40:55.5382186-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:40:55.5382186-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "48630a5b-8812-4bd7-becf-5c9d6aaaf5a0",
"CreateDate": "2026-08-09T23:40:55.5382186-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T23:40:55.5382186-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e1a656d2-4033-43c0-8cdf-4c1d36d6d427",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a070f767-e6d1-492a-9671-93460b16d95d",
"CreateDate": "2026-08-09T23:40:55.5382186-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T23:40:55.5382186-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-09T23:40:55.5382186-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "28c084ea-fa93-448e-b4f2-1c72e28e34a8",
"CreateDate": "2026-08-09T23:40:55.5382186-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T23:40:55.5382186-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": "e4101c86-239d-4afe-932d-908d7d528929",
"Asset": {
"AssetId": "1c72ed2b-7ced-41ac-a1c2-f46016f9b502",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7508b4b7-5f58-47c2-826f-0d7747d99b60",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4600d8a2-aeb5-45c6-b795-656effdf71cd",
"CreateDate": "2026-08-09T23:40:55.7725317-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:40:55.7725317-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4845bf8d-2e3d-4299-95eb-e801ba10e57e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:40:55.7725317-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:40:55.7725317-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e024cba5-a6e4-4337-a347-8b28d2d5bb19",
"CreateDate": "2026-08-09T23:40:55.7725317-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:40:55.7725317-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-09T23:40:55.7725317-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:40:55.7725317-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cc473e6d-2159-4cae-99a3-fd11b08e49cd",
"CreateDate": "2026-08-09T23:40:55.7725317-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T23:40:55.7725317-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "0a70c06d-f871-4db8-b86b-708048186513",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "03a95e4e-44cb-4ba4-ad7a-2093b890089f",
"CreateDate": "2026-08-09T23:40:55.7725317-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T23:40:55.7725317-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-09T23:40:55.7725317-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "23c58aaf-83e4-4a1d-a4cd-1d7a4e14f168",
"CreateDate": "2026-08-09T23:40:55.7725317-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T23:40:55.7725317-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}