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": "886ab983-3445-4a57-9b5e-8c994288c371",
"Asset": {
"AssetId": "f81c2247-3264-435b-8aef-749b58542263",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "08ddb7f9-57e1-439c-b7ba-9928b0754f39",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34daa7d0-6a22-4a16-8ea7-7d4c0ea9ea79",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a34d61c5-0071-47e4-b5da-ec705a6ac453",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-04T16:17:02.6317077-07:00",
"MeasurementValueNeededDate": "2026-07-04T16:17:02.6317077-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6bdd5130-50ab-4d8e-a732-85928be9251c",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "98634c5c-d40b-4ed7-a427-3a185bea86bb",
"EffectiveDate": "2026-07-04T16:17:02.6317077-07:00",
"StateType": {
"StateTypeId": "a61549d9-4231-4db3-8c9e-544bae16756a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "08ddb7f9-57e1-439c-b7ba-9928b0754f39",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34daa7d0-6a22-4a16-8ea7-7d4c0ea9ea79",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e3fee07a-e30a-4f25-937e-6d2897a6a90f",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "341262e3-d267-4fca-b18e-5923a2daa360",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "36615520-1e85-44e9-b0f8-e5f3ac5caafb",
"EffectiveDate": "2026-07-04T16:17:02.6317077-07:00",
"StatusType": {
"StatusTypeId": "d393d168-87d2-45b0-99db-ae687d43c09f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "08ddb7f9-57e1-439c-b7ba-9928b0754f39",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34daa7d0-6a22-4a16-8ea7-7d4c0ea9ea79",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8302a7e1-bda5-4a13-903b-79f324d921a9",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2bcc5d20-1122-4428-8c28-7bd6bba22acb",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "15e08b4d-c07a-4175-937c-ea4b7d16ba95",
"EffectiveDate": "2026-07-04T16:17:02.6317077-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "01a943a5-766e-4639-aebe-4059788a6bfa",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed32f4e9-2bae-45ef-a970-22d766f207f8",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "00c9fbb3-5898-44ce-8af2-5211dd7f4eb9",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-04T16:17:02.6317077-07:00",
"MeasurementValueNeededDate": "2026-07-04T16:17:02.6317077-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bb86d2f9-51ab-4a23-8918-6342451bfd6f",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "358db31d-d5e5-4d5a-86c7-2cbae4b60918",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e0e34a61-baba-4c71-84be-d32a7f7d0aa3",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-04T16:17:02.6317077-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ee4b94cc-27e9-473d-bf55-ba910a7cba99",
"CreateDate": "2026-07-04T16:17:02.6317077-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-04T16:17:02.6317077-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": "f0ee9017-3d11-4fa5-8315-622e6c181c5f",
"Asset": {
"AssetId": "ffe39cfe-8341-4f57-a8c4-125c54ca1f71",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "db6da15c-3704-4bfd-82af-ebd7f391d959",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25395fac-aa28-418c-aac5-58be1b2c224a",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a7c87535-0a66-4edb-aa10-cb9dcf1391e0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-04T16:17:02.6472379-07:00",
"MeasurementValueNeededDate": "2026-07-04T16:17:02.6472379-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bc3a7209-4dc4-4f48-bf2b-6035df9ee32e",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "90b0bfda-171c-4f0c-9bb5-4d5ccc1f6e7c",
"EffectiveDate": "2026-07-04T16:17:02.6472379-07:00",
"StateType": {
"StateTypeId": "d646b1ba-208d-43a6-b219-1919e8c6bb04",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "db6da15c-3704-4bfd-82af-ebd7f391d959",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25395fac-aa28-418c-aac5-58be1b2c224a",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "49c69955-c062-4b27-bbf5-8d1fafb2b159",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3fa257f0-e97c-4df3-be11-f1dc92413c90",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e6a77fcf-eefb-43af-882f-427a0dd1eaf9",
"EffectiveDate": "2026-07-04T16:17:02.6472379-07:00",
"StatusType": {
"StatusTypeId": "8e96738e-0843-4330-9654-d83dc7d78bcb",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "db6da15c-3704-4bfd-82af-ebd7f391d959",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25395fac-aa28-418c-aac5-58be1b2c224a",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6f0a23ca-4b97-4c02-b4f0-32e4d1abef0f",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f1d1566e-4495-4cc6-8738-8a4c582209dd",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "13d20053-62a6-41f1-b148-842e27849f32",
"EffectiveDate": "2026-07-04T16:17:02.6472379-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "859652e2-5b81-4e9b-b024-c1e173aea985",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7090771d-cd74-4077-951e-ea8acf00ea35",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c7da998f-0358-4bff-846b-efca4e5a9b41",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-04T16:17:02.6472379-07:00",
"MeasurementValueNeededDate": "2026-07-04T16:17:02.6472379-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "8c10a155-0d11-4aea-9549-ebfefb285938",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "625446a9-affd-41cf-a099-d654c2f76339",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "daf5649a-c8b2-4033-b113-e0c1a9d49ddf",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-07-04T16:17:02.6472379-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9b562303-3ae1-493b-9480-759bb15b1b69",
"CreateDate": "2026-07-04T16:17:02.6472379-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-04T16:17:02.6472379-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}