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": "af1de439-517d-4fc4-a411-50201f66cb69",
"Asset": {
"AssetId": "c6efe0c2-88af-42b4-bafd-59c9f5fa27bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "163c1d18-4fce-4f88-b799-b5629776c603",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fefd2acb-744e-4f59-9b1b-b36668802702",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "39b2886c-4654-4c8f-b53e-7890fa0de2cf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-17T03:52:43.6696597-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:52:43.6696597-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ac9eaa2a-89a4-4fa0-b138-2efb72825fc9",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ab45705f-2e69-4afe-9d07-d31fa6be0d53",
"EffectiveDate": "2025-04-17T03:52:43.6696597-07:00",
"StateType": {
"StateTypeId": "f13b945a-bc4a-455a-8f2e-e190717d0ec0",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "163c1d18-4fce-4f88-b799-b5629776c603",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fefd2acb-744e-4f59-9b1b-b36668802702",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a67f6ed8-21cd-4e2f-be26-e6bd596af0a8",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "84c11bb8-9a03-4f21-a8a1-5ee912ce33ae",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "bac09a3c-8a81-45fc-8e93-2beb1a3067ce",
"EffectiveDate": "2025-04-17T03:52:43.6696597-07:00",
"StatusType": {
"StatusTypeId": "6304e046-5119-40f9-a608-8151eaf9c9c7",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "163c1d18-4fce-4f88-b799-b5629776c603",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fefd2acb-744e-4f59-9b1b-b36668802702",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "300d85ab-dba0-47ce-97bf-5ba7e321da81",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ac3029fa-068d-45c6-a894-ccd502ea7706",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "39a82cfc-9a8c-418f-9cf7-5662f8bd18ac",
"EffectiveDate": "2025-04-17T03:52:43.6696597-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d8389fde-da07-4848-882a-31d8bd65100c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "09f3f80a-b723-461c-9578-0813d033321c",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6584e1b0-13d6-40e8-b8ff-4be37a6ff7e2",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-17T03:52:43.6696597-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:52:43.6696597-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "08b242c4-ba89-4f5a-bf74-088e70c6c530",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "94905352-1c32-4bdd-9346-1a4a9284fdc5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e0df4ec9-6b02-4b17-89c2-bd998b2b2b36",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-17T03:52:43.6696597-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a15f020d-21ad-4668-90b4-93cbc1c54645",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-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": "7eed7a04-b42a-42fc-8dc3-d09481ab883c",
"Asset": {
"AssetId": "5c1d51ae-456f-47d2-b3ea-6f8859acd560",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c10ca9c0-33ce-4042-8b70-d9fd7f9da4bf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1722a86-cbe5-4041-8bd0-a1cccd728b6e",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "68bab183-7b05-40ec-9aee-ece65586e7af",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-17T03:52:43.6696597-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:52:43.6696597-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "007c4480-3f74-431c-ba7b-191357d24b60",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "be246d33-a78b-4d1f-9c8a-f8886b94361e",
"EffectiveDate": "2025-04-17T03:52:43.6696597-07:00",
"StateType": {
"StateTypeId": "68d04457-b635-49a0-ae33-d8c2fe1d9c18",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c10ca9c0-33ce-4042-8b70-d9fd7f9da4bf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1722a86-cbe5-4041-8bd0-a1cccd728b6e",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f1c4d8ac-9ac8-4d3c-8546-3126817617c7",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bda841af-d724-4c5f-b14f-d6530015eb5b",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "79560dd9-6a0b-404f-944c-5b49041590c5",
"EffectiveDate": "2025-04-17T03:52:43.6696597-07:00",
"StatusType": {
"StatusTypeId": "ec008f02-be7c-470c-b1c8-eb7a7eb52f88",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c10ca9c0-33ce-4042-8b70-d9fd7f9da4bf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1722a86-cbe5-4041-8bd0-a1cccd728b6e",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "97692bb3-1607-4620-8672-82aa4fbf4624",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5489d844-034f-481c-83d2-764508da4cf3",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "04e354b4-f433-4c97-9f2f-86be95c71bbf",
"EffectiveDate": "2025-04-17T03:52:43.6696597-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "97afce48-f18b-4838-87e9-5c2453783563",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7ad09429-f18a-45ab-8a75-4000a77fdc9a",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d20c3fea-98b0-46c5-a64a-901427c167a6",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-17T03:52:43.6696597-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:52:43.6696597-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5f9d5780-18ff-4f87-93ad-83807f1ec8af",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "87053a43-d6ef-4825-a307-ba0c858d61bf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2265d5be-42e3-4330-af9f-a9a1680f0d56",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-17T03:52:43.6696597-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ad78e50d-4513-4aed-a354-bbc05c7f7ec8",
"CreateDate": "2025-04-17T03:52:43.6696597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:52:43.6696597-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}