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": "6e5e7ee5-33f5-4302-b955-954a50b6ba28",
"Asset": {
"AssetId": "afbd7f21-bfb3-485a-8a55-c95fd1b42631",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4996f9d0-8f72-4ed0-80c5-f8cac24bc9e6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "31971309-304d-4fa5-a427-2317d5da1012",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "39a1da4e-8036-4280-94de-9b0f5a8f723f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-01T11:51:10.9141124-08:00",
"MeasurementValueNeededDate": "2025-12-01T11:51:10.9141124-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "474879fb-1b64-44fe-b435-434c78f4c40c",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-01T11:51:10.9141124-08:00",
"MeasurementValueNeededDate": "2025-12-01T11:51:10.9141124-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4c17d837-0fc7-49c4-a222-8e9b94544450",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "3632f5bf-6a20-4564-890f-4025785225c0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5114e252-68c1-452e-b72a-ee1da3d90c6b",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-01T11:51:10.9141124-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "65c2bf4e-b17d-4b50-8210-54c900fe2e4d",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08: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": "e778e112-7ee3-4f98-94a6-7a702f8c085f",
"Asset": {
"AssetId": "a7df1407-8a6a-45ed-9491-81a331c1de42",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2b9b1c6f-45af-4c86-b91d-82ad04e42e9c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "32121268-c55d-4e9d-bca2-321395e496fd",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "112c9242-fd62-471d-a12d-dc2db8451f7c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-01T11:51:10.9141124-08:00",
"MeasurementValueNeededDate": "2025-12-01T11:51:10.9141124-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ccaa1dc9-59b9-4490-ac7c-6a8ab7546ef3",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-01T11:51:10.9141124-08:00",
"MeasurementValueNeededDate": "2025-12-01T11:51:10.9141124-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fad36b57-0331-4ce4-a32b-0717018a6152",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2cf3d823-7cfe-4861-a5e2-90bf584f8b6a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8fbed6c2-c9df-4878-9b3c-1632a7117c60",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-01T11:51:10.9141124-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d0b7afbb-c72d-4bfe-9dd9-f49eb0a49d67",
"CreateDate": "2025-12-01T11:51:10.9141124-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T11:51:10.9141124-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}