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": "78850d85-e56b-4972-acd5-843b18a2cb7b",
"Asset": {
"AssetId": "0d540376-ddb8-4c41-9a19-51707354924e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ac329da2-e9b5-40b8-8e23-50ae1935bed2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5a51426d-a0cf-41c1-a6aa-ea9ead3b3af7",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "573e8536-c986-4440-8e14-4c5aa04dab15",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-24T00:29:26.6784828-07:00",
"MeasurementValueNeededDate": "2026-08-24T00:29:26.6784828-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4751ece8-40f6-49ba-9d51-ebbacba0df2d",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "458cc25e-4a4c-478a-8fc0-407c27c0873d",
"EffectiveDate": "2026-08-24T00:29:26.6784828-07:00",
"StateType": {
"StateTypeId": "2bf674c3-abf4-4999-9ebd-bfdeb7a5a942",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ac329da2-e9b5-40b8-8e23-50ae1935bed2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5a51426d-a0cf-41c1-a6aa-ea9ead3b3af7",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "517fe4f7-ef84-4cff-a85f-bbb1f7f11d39",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "041070dd-77f7-4af8-b0cb-fc3d360968fe",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "53db8cde-37c9-49d3-a4eb-00a2034cb2bc",
"EffectiveDate": "2026-08-24T00:29:26.6784828-07:00",
"StatusType": {
"StatusTypeId": "b623c1c7-a2b8-41c8-9bce-47c8d2b8020b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ac329da2-e9b5-40b8-8e23-50ae1935bed2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5a51426d-a0cf-41c1-a6aa-ea9ead3b3af7",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "310ac096-3c92-4167-b725-88ff5c836155",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ede45cc4-f4f5-4615-839d-f0bd3ae0a2f6",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "662a6b3d-4e15-4d4d-ae2b-0851b0417110",
"EffectiveDate": "2026-08-24T00:29:26.6784828-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "bf892cab-ba51-46ed-a428-bf5aac92a254",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bb9a510a-23eb-432a-b045-b08486de8e21",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "27ff2e04-bb59-4397-a77d-fb5303f6efdc",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-24T00:29:26.6784828-07:00",
"MeasurementValueNeededDate": "2026-08-24T00:29:26.6784828-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5a23c996-016a-4272-bf2b-4523d4669b67",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "88a7466f-37e7-4df3-8252-089ee38e6dc6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f95cbc32-a96a-4da6-abbe-5fb2f7c2ac4a",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-24T00:29:26.6784828-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "015788b0-15a2-4496-86ae-246163967aac",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-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": "775eb40c-9e4a-4939-8179-a3f83b9d9f55",
"Asset": {
"AssetId": "9ad75741-1c19-41ac-b90a-1db94790c686",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "35486327-ddff-42a7-b93b-6f2997272f9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e697c02c-5da7-4590-a1a7-d35a3273c945",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "11488b60-3393-4a56-94d9-0faf635d608b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-24T00:29:26.6784828-07:00",
"MeasurementValueNeededDate": "2026-08-24T00:29:26.6784828-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0faedc32-d250-4f96-ba09-a2638bb784a1",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "9b545816-c416-49ec-b792-38fe4729cbad",
"EffectiveDate": "2026-08-24T00:29:26.6784828-07:00",
"StateType": {
"StateTypeId": "294cab5e-9957-42fa-92d4-bf188b898c2a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "35486327-ddff-42a7-b93b-6f2997272f9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e697c02c-5da7-4590-a1a7-d35a3273c945",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3119edbd-1923-4d1d-86b5-5fc10f07753e",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d68fc3d5-fd15-4bca-b3a2-d6ff5748ebac",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0543f8d4-b083-412a-8507-070e45fd1cfb",
"EffectiveDate": "2026-08-24T00:29:26.6784828-07:00",
"StatusType": {
"StatusTypeId": "7998de1e-34a7-4d39-91fa-b2359fe25d5f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "35486327-ddff-42a7-b93b-6f2997272f9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e697c02c-5da7-4590-a1a7-d35a3273c945",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6f034613-a4d5-401e-852d-021bea236489",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "19c231d6-cfd0-40da-9e31-d1abaf396f71",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "cf838514-477b-4ea3-90be-7e70615aa48a",
"EffectiveDate": "2026-08-24T00:29:26.6784828-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "22afb785-3c46-434c-a59a-5c7519343147",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4a974933-9cc5-4878-b706-ea2948e7e627",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "030b04c3-199f-4d02-995e-5291f1cd54a7",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-24T00:29:26.6784828-07:00",
"MeasurementValueNeededDate": "2026-08-24T00:29:26.6784828-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8f5ea3ac-2d2e-4463-9dbc-4e3b692e6b13",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "0f572b1c-5af8-4a21-8d6e-1f6ea1d88fec",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "25f8545b-2029-4a55-91ae-9a730bd9c3fa",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-24T00:29:26.6784828-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1bbf3573-b663-46ad-a848-fafa19770563",
"CreateDate": "2026-08-24T00:29:26.6784828-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T00:29:26.6784828-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}