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": "c8067613-46bb-406f-a9fc-3ec940fbe273",
"Asset": {
"AssetId": "b84d64c7-276b-4512-9172-d8fbc49a4f93",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7164cf0a-767e-4c91-83ec-b29af496481d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "10648acb-608b-4e81-a8af-c271cb461905",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3b663694-55e9-4720-a69e-5d7e44b7bbce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T07:58:20.3825217-08:00",
"MeasurementValueNeededDate": "2025-02-05T07:58:20.3825217-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c96268e8-7e60-4ecf-a6cf-9bb66539ef48",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T07:58:20.3825217-08:00",
"MeasurementValueNeededDate": "2025-02-05T07:58:20.3825217-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "aa0a846c-822c-4e64-bb0e-31fc85d3eb20",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e5de2229-6ebd-4f6b-8fb8-13b57b59a1f3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9d498631-4883-4e68-8829-84d6c716deb5",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T07:58:20.3825217-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "63a8ece3-326a-47f5-bf0e-95869f20e5c3",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-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": "be22f148-9615-4ae9-8d9c-c2ab71335ac1",
"Asset": {
"AssetId": "f214b65d-7f63-4db4-8130-a9da111b5e94",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "01663ebd-1961-452e-abb7-6fc174c47511",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a524bce7-92d9-4dca-aba1-50376e5e5370",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f86abf17-22ad-46d0-9a80-a36861e18a5a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T07:58:20.3825217-08:00",
"MeasurementValueNeededDate": "2025-02-05T07:58:20.3825217-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "db83143c-948b-42ae-b21a-99f24a4b504b",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T07:58:20.3825217-08:00",
"MeasurementValueNeededDate": "2025-02-05T07:58:20.3825217-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d21c757d-99dd-4d8a-abe3-04f3d4b1e857",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "27743291-cb92-45ac-9e06-b1e0d0ce0cde",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "598d4309-34a8-4b28-8e2d-84179d98fb9e",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T07:58:20.3825217-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "912719bd-c8ef-43c4-a6fc-342fdd7c281f",
"CreateDate": "2025-02-05T07:58:20.3825217-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T07:58:20.3825217-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}