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": "049587b3-2b71-4e27-b491-2790aaa3ef04",
"Asset": {
"AssetId": "4bd3753a-e67a-47ab-8753-3313d2503e97",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e4bf7104-f0ae-40bb-9c7e-c2d59c88d9ca",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4e157e62-00f8-4e87-a210-f7bce3d311c0",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9f643fcc-c161-49e6-a5b6-65f93c794c7e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-24T13:38:49.0201099-07:00",
"MeasurementValueNeededDate": "2025-04-24T13:38:49.0201099-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bc0f1b6d-9e12-4f54-ac8a-93129e69ebad",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-24T13:38:49.0201099-07:00",
"MeasurementValueNeededDate": "2025-04-24T13:38:49.0201099-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bf74761f-e461-472c-84d2-49e732869d26",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "2bb752a3-ca10-403c-86fe-a3e0b8a9206f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "24d42198-c6d4-4d65-9a71-58ce45a0d5fe",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-24T13:38:49.0201099-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f23732a8-c161-4d29-836a-70c08c29d75a",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-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": "ee912803-7e1e-4a28-adbb-63710a325e70",
"Asset": {
"AssetId": "5d7aa638-4d54-4ede-b83a-31bc455eb218",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ed5fe4ab-c160-4ca2-a3ed-8ca04b7ca2fd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f9498336-f37b-418c-a649-0118f6d1c2d9",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a13c8089-4f67-4e94-898d-0fbac3ed79b5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-24T13:38:49.0201099-07:00",
"MeasurementValueNeededDate": "2025-04-24T13:38:49.0201099-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "446e31e4-5c5a-4aff-ac96-9ad744166e1d",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-04-24T13:38:49.0201099-07:00",
"MeasurementValueNeededDate": "2025-04-24T13:38:49.0201099-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "98d278af-6110-47a6-8caf-d8b3169ad511",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "4b4707ef-42f2-422a-81a3-e376f4277f44",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b7845469-5380-4e89-96a8-1f4931233cf4",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-24T13:38:49.0201099-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3c908d07-51d3-4545-97e1-af5c56906b37",
"CreateDate": "2025-04-24T13:38:49.0201099-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-24T13:38:49.0201099-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}