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": "18b3539f-71ba-4a85-b50b-726e5b10c53b",
"Asset": {
"AssetId": "6e41d474-dc54-4a55-baab-d1a17a8f7c0d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6298c7b2-ae5d-4b5b-b09d-f5a82324110d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "041f03c9-6dfc-49f4-be4b-7f8cd5b28d9f",
"CreateDate": "2025-07-01T15:32:32.2915348-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-01T15:32:32.2915348-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "84fcb66d-d2a0-4899-a003-0940c544b3b3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-01T15:32:32.2915348-07:00",
"MeasurementValueNeededDate": "2025-07-01T15:32:32.2915348-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "35f2dbd9-1397-43b4-8074-4c5b53980d4e",
"CreateDate": "2025-07-01T15:32:32.2915348-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-01T15:32:32.2915348-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-01T15:32:32.2915348-07:00",
"MeasurementValueNeededDate": "2025-07-01T15:32:32.2915348-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "84ae47d7-4761-4720-b2bd-6eb193f22d3e",
"CreateDate": "2025-07-01T15:32:32.2915348-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-01T15:32:32.2915348-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "0360d234-24f8-4fa7-9b96-cbac2f2187a9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dd2f5c8a-f977-426f-9dc7-00db502a1821",
"CreateDate": "2025-07-01T15:32:32.2915348-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-01T15:32:32.2915348-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-01T15:32:32.2915348-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ad9ec43c-c28c-475b-9d84-e687dce83cbc",
"CreateDate": "2025-07-01T15:32:32.2915348-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-01T15:32:32.2915348-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": "9be60fcb-2466-4c84-9dc4-4885030d9e9c",
"Asset": {
"AssetId": "e6b8c271-34a6-4bd3-91c6-31cbf2110aaa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f9bee02d-a453-4e00-b765-f3027c590969",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98d0b84a-6abe-4b68-ae6c-1d319466a84d",
"CreateDate": "2025-07-01T15:32:32.3540422-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-01T15:32:32.3540422-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7a1a4410-5f12-46c6-8e60-218cba6fa5e8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-01T15:32:32.3540422-07:00",
"MeasurementValueNeededDate": "2025-07-01T15:32:32.3540422-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c82d5141-29d0-4524-9c9f-3ffcf89c14ab",
"CreateDate": "2025-07-01T15:32:32.3540422-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-01T15:32:32.3540422-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-07-01T15:32:32.3540422-07:00",
"MeasurementValueNeededDate": "2025-07-01T15:32:32.3540422-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f5448e7c-e669-4870-a84d-2a715f20b9dd",
"CreateDate": "2025-07-01T15:32:32.3540422-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-01T15:32:32.3540422-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "6690296d-3fb6-4946-8a79-a02f00580529",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ee7bd5f3-226b-426c-9d43-b78c378752b4",
"CreateDate": "2025-07-01T15:32:32.3540422-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-01T15:32:32.3540422-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-01T15:32:32.3540422-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "70948483-979d-44e8-ab55-4ff99c0e99b0",
"CreateDate": "2025-07-01T15:32:32.3540422-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-01T15:32:32.3540422-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}