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": "22eafac1-127d-4b56-9e91-6bfcc1303a24",
"Asset": {
"AssetId": "76063c22-8bd1-4e7a-8779-49764d53cd55",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bf217cab-076c-42b9-85aa-ffad20d11ce0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "42f02600-bc03-4e70-ab90-b37708819afe",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6e99ff94-b34d-472a-9664-d9c7417dd98b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T06:29:26.4893973-07:00",
"MeasurementValueNeededDate": "2025-06-02T06:29:26.4893973-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "83840afc-3436-467c-a7c1-05a581d76d44",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-02T06:29:26.4893973-07:00",
"MeasurementValueNeededDate": "2025-06-02T06:29:26.4893973-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8272e9d5-4046-443e-8e82-0972e353f8ae",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "31cf4b14-cbc7-41af-80be-9a29ca938094",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ee4e6f2c-3dd3-4e4f-85d5-ec4c55d035df",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T06:29:26.4893973-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c3ad650d-7ace-4a83-94ce-88e8ac6d8b0f",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-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": "7a89e861-5bad-47af-8c15-a79219fa4027",
"Asset": {
"AssetId": "922de98d-6db6-48f0-a64d-e450bef22aa4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a6147521-9ae2-4180-b6be-c489211f1953",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "85233a6d-1950-4e61-acd9-46ed2d9afecf",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e11f1e7f-1c53-44ac-910f-c3ea0046992d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T06:29:26.4893973-07:00",
"MeasurementValueNeededDate": "2025-06-02T06:29:26.4893973-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2358c91d-f3aa-48d0-94cb-cafe17782ec7",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-02T06:29:26.4893973-07:00",
"MeasurementValueNeededDate": "2025-06-02T06:29:26.4893973-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d7aad804-d12c-4852-8def-4724e503fea0",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "eff05d48-4e5f-4746-9063-677c2f679605",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ff26c6f2-4361-476d-a187-dde61f391c3e",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T06:29:26.4893973-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9c7c0b62-d100-4b98-81e5-245b9613305e",
"CreateDate": "2025-06-02T06:29:26.4893973-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T06:29:26.4893973-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}