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": "7bc68705-0700-42a7-b4c1-23d588e8bc1f",
"Asset": {
"AssetId": "642b9e67-0313-4daf-be64-6e9e05ec3b2c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b49c904c-2be9-402f-8263-3a5597deb2f5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ec696316-f7d0-4fa5-b124-3410dc3f8e0c",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "afa2a6fe-72bc-40fc-b2cd-afdb22cacdcd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-30T08:48:34.8853733-08:00",
"MeasurementValueNeededDate": "2025-12-30T08:48:34.8853733-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e89aa926-bd4f-41e0-9b98-9bf689b2f819",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-30T08:48:34.8853733-08:00",
"MeasurementValueNeededDate": "2025-12-30T08:48:34.8853733-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "34969fa9-2f84-42fd-ab8b-b8d67ca17715",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "9b010de1-aea3-46fd-a34a-ab03e359ba88",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "987f35ab-949a-406f-9a2a-8e1f04d13c3b",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-30T08:48:34.8853733-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a82ac514-484b-4698-87a5-305eb9e254f8",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-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": "2563765e-83f7-4e80-bd29-6572bd05399c",
"Asset": {
"AssetId": "9f6dd385-14ce-4cf1-8c50-839ea109edd9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ea01c920-dbb9-4b28-a89e-77d554eb3483",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1aae0a0b-05e7-4159-b819-e78f022d386b",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ca5bfd66-0d57-46f6-ac37-05da24dcb8e7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-30T08:48:34.8853733-08:00",
"MeasurementValueNeededDate": "2025-12-30T08:48:34.8853733-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f8509285-8ece-4c15-a458-02e235bd1963",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-30T08:48:34.8853733-08:00",
"MeasurementValueNeededDate": "2025-12-30T08:48:34.8853733-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cb0e7e02-08fc-4295-89da-50d753e763b0",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f6287cd7-2087-412b-90fc-fc5e3baba6f4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dba41b83-7752-4c5e-b0b3-7fd968b84a71",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-30T08:48:34.8853733-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7c216df6-5d6c-464d-bf2b-20483b926092",
"CreateDate": "2025-12-30T08:48:34.8853733-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-30T08:48:34.8853733-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}