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": "1566f9aa-9ba1-42dd-8a98-1024511b6c56",
"Asset": {
"AssetId": "99b94b32-ee4d-40db-a020-029c6a3e7c62",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2ef338f6-13d2-4602-8b42-a6b33139dfbe",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d0b0e56a-e929-4a78-882a-f44ebf3739ad",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c403cadd-5a55-413f-b08e-41f9a2a79f50",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-23T22:46:06.9819738-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:46:06.9819738-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "edc35fab-6388-4c01-86b0-39be82d9c90e",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-23T22:46:06.9819738-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:46:06.9819738-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f27ee66f-d41b-49de-b779-1bf056d8aa78",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e323641c-daf2-48d7-a82b-3750b755fc85",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dc90bd81-addd-4089-a519-5607a5febe73",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-23T22:46:06.9819738-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "08c8fecf-6abd-4199-8089-9f332165b733",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-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": "3d188344-5c6b-43a9-9ea5-036c48b4428b",
"Asset": {
"AssetId": "891e6a0a-c420-4cd9-9660-448dd438c0b7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d024066a-0ee2-43dd-8054-0d4b55d02b6b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "840c21f1-4877-40f9-b495-3a364f820756",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fb22d495-0689-4f95-b5f7-271f536e2cf1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-23T22:46:06.9819738-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:46:06.9819738-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b8e7e186-b597-4b47-89dd-b47c947bae82",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-08-23T22:46:06.9819738-07:00",
"MeasurementValueNeededDate": "2025-08-23T22:46:06.9819738-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "dca5d1d1-6b75-41c0-b5c7-83f8afb9b96b",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "76597503-ad55-4b02-a81c-1b1e2dededaf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8836f29a-6b9f-4a05-9621-134922ea12f6",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-23T22:46:06.9819738-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "13cfedf6-bf68-4dd5-9e6f-74d8d19f830c",
"CreateDate": "2025-08-23T22:46:06.9819738-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-23T22:46:06.9819738-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}