PUT Notes
Updates the given note.
Request Information
URI Parameters
None.
Body Parameters
The note to update
Note| Name | Description | Type | Additional information |
|---|---|---|---|
| NoteId | globally unique identifier |
None. |
|
| Asset | Asset |
None. |
|
| OnBehalfOf | string |
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": "ab0d01de-d2b4-4a99-b86d-78b976ab7e58",
"Asset": {
"AssetId": "837ee8a5-5d7e-4537-838d-e2c193873d07",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0059e37b-5747-41f6-808d-5e6e860f60be",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f49d3d73-db66-43d4-b7be-2df3454526f6",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "76048dca-dc91-4ea5-b4e3-c6277f8dfad5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-07T12:40:09.0589988-07:00",
"MeasurementValueNeededDate": "2026-06-07T12:40:09.0589988-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6144ebf0-9a47-43a5-896c-fc6b8471912e",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c7a7407b-ffb3-4dec-9d90-f30d23a36b32",
"EffectiveDate": "2026-06-07T12:40:09.0589988-07:00",
"StateType": {
"StateTypeId": "0f80f801-b78b-4a7a-aa8f-0494a3c176c5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0059e37b-5747-41f6-808d-5e6e860f60be",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f49d3d73-db66-43d4-b7be-2df3454526f6",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "071dd048-04be-4522-8a48-0ae5b0fe3aec",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "47bc0329-b267-4e77-9b44-f5b3e715ed94",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "686c6b0b-a16c-486b-bdaf-2b44d6a46453",
"EffectiveDate": "2026-06-07T12:40:09.0589988-07:00",
"StatusType": {
"StatusTypeId": "41fb6674-cfda-46b4-b6e1-af9962de519c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0059e37b-5747-41f6-808d-5e6e860f60be",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f49d3d73-db66-43d4-b7be-2df3454526f6",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "24e420b4-645a-45de-a89b-f79edb6afef5",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "450f4a2b-d91d-4e3d-a103-0f8c926bae8e",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "38cbabff-8ba5-4062-b853-1122dc4ae954",
"EffectiveDate": "2026-06-07T12:40:09.0589988-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5a4dc545-53fd-4a98-88c6-aa62531b4629",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f9a6bbd8-1120-49ec-87b4-5a26d92dc969",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7dc7b8d8-4a82-4cf1-b51f-fa8d254c2f01",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-07T12:40:09.0589988-07:00",
"MeasurementValueNeededDate": "2026-06-07T12:40:09.0589988-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0069c971-3141-43f7-bbaf-cf327cef0d35",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "502b2fff-de35-46f9-9d97-4c637cd6a6e6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c208909f-758c-4e6e-99ca-d042d6a71860",
"CreateDate": "2026-06-07T12:40:09.0589988-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-07T12:40:09.0589988-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-07T12:40:09.0589988-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "18f53952-0425-4b8f-b01c-1af052d45524",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 6"
}
Response Information
Resource Description
On success, the updated note.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"NoteId": "0f87d8ef-1db5-43e7-b776-780ecb1d233a",
"Asset": {
"AssetId": "299c4e38-ec22-44ad-90b1-a2c40e984988",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "96669cd6-64ef-4398-b347-6f7043a7b6b6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ba15bed2-3330-4b5b-ac6a-6be77829d640",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b9c172a4-b8ea-4dfe-b78d-453fa2987903",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-07T12:40:09.0747051-07:00",
"MeasurementValueNeededDate": "2026-06-07T12:40:09.0747051-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "75d96371-924c-4ae2-9b98-77eae133283a",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e2e3e779-5cb6-4bfa-9f46-24c7b56344d5",
"EffectiveDate": "2026-06-07T12:40:09.0747051-07:00",
"StateType": {
"StateTypeId": "b753a11f-978a-4236-87e7-2342d440819a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "96669cd6-64ef-4398-b347-6f7043a7b6b6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ba15bed2-3330-4b5b-ac6a-6be77829d640",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f3bafaeb-c197-4b70-b9e2-1fb2c38b05c5",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ce42744b-1efb-48fb-9170-0f954d444a2c",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "04ccbc0b-b6e7-4061-8490-ace014fa728f",
"EffectiveDate": "2026-06-07T12:40:09.0747051-07:00",
"StatusType": {
"StatusTypeId": "13bcbd65-437e-4a5e-a184-fa8cd62aa286",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "96669cd6-64ef-4398-b347-6f7043a7b6b6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ba15bed2-3330-4b5b-ac6a-6be77829d640",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8f9a3a23-0403-426a-aedc-b79ba79cb602",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "190e62bc-93ac-4864-8fd8-d25d05d49012",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fb4b1c47-a7fa-42d0-a69c-66470db4ad32",
"EffectiveDate": "2026-06-07T12:40:09.0747051-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "1ce25bf6-8c34-431c-a8aa-5e53adcc2738",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "67f70eaf-5c5d-4b22-956e-5b388e308f40",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "04d7cc5d-ec4f-46e1-8d16-ed5124c68d1d",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-07T12:40:09.0747051-07:00",
"MeasurementValueNeededDate": "2026-06-07T12:40:09.0747051-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d35d5286-595b-4fb9-acd0-4a82ed7ea6b9",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "eb7769a3-1430-44c6-83f0-6db8a2727fb6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "24d157c8-9d84-4002-ac9c-6480c060abab",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-07T12:40:09.0747051-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8eaae0d9-b603-490a-b244-78e991c48e20",
"CreateDate": "2026-06-07T12:40:09.0747051-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-07T12:40:09.0747051-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}