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": "be49a0ce-8d19-405b-821d-59de2d04d938",
"Asset": {
"AssetId": "1febcce5-df7d-4723-87a7-173234686e2f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7e361fff-0bc1-49d3-909b-69b1d91ecafb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9c78f0a9-c387-418d-84dd-d4ff33675643",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7164a632-8886-4077-9d2f-722f94dcb77b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T10:27:02.5998053-07:00",
"MeasurementValueNeededDate": "2026-03-09T10:27:02.5998053-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5da9f54a-6d7f-422f-991f-120503803e69",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "10da15b8-f99e-49ba-9314-cf9c20ec124a",
"EffectiveDate": "2026-03-09T10:27:02.5998053-07:00",
"StateType": {
"StateTypeId": "7a88908c-68c6-4573-8120-09cbdfaa4962",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7e361fff-0bc1-49d3-909b-69b1d91ecafb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9c78f0a9-c387-418d-84dd-d4ff33675643",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d278166c-1bf8-475b-a02c-13413a79471f",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4c34cb23-9d12-4c5e-9d30-041d3f077fba",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e941a325-a898-46b3-9a81-d7fec877be3b",
"EffectiveDate": "2026-03-09T10:27:02.5998053-07:00",
"StatusType": {
"StatusTypeId": "ef142f59-2471-49e2-8ab0-9eed331fcc0c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7e361fff-0bc1-49d3-909b-69b1d91ecafb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9c78f0a9-c387-418d-84dd-d4ff33675643",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "571e4920-49c3-4bf1-8d0d-ebe21d06583f",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6ce80aee-9242-4e53-9e56-06a52a439d6d",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b76a5a52-844e-453e-9f98-083b19cf2cd7",
"EffectiveDate": "2026-03-09T10:27:02.5998053-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "48ac6797-ab61-4f85-b3cb-baddb42d3d71",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9cf55919-5e45-4a30-9487-c0b9a944bd2d",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0d600ec6-250c-4639-91fd-96c6b5f662c8",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-09T10:27:02.5998053-07:00",
"MeasurementValueNeededDate": "2026-03-09T10:27:02.5998053-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7ab37bb2-e869-4edc-a940-dd77247fc5f4",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "fd96d61e-f13f-4e06-9dd4-81911e60522d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "545daf1b-4c11-4327-8d3a-cc960080d8a9",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-09T10:27:02.5998053-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "39262bc7-fbe3-4fdd-bc80-a748d33126b0",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-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": "8bef77ef-94e9-449b-a7c9-142a5a787abc",
"Asset": {
"AssetId": "b3859686-5a2e-4ca2-8a17-c857ca84fa74",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a67c67b3-b0b2-4b29-8ad9-e021e7e1dbec",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4a2631a4-a758-43ca-9443-e76295da0572",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c8c93a81-1504-4217-ae9a-f5cc3cc23dbe",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T10:27:02.5998053-07:00",
"MeasurementValueNeededDate": "2026-03-09T10:27:02.5998053-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "169d1f4c-f50b-466b-af0b-0194c1777b34",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fd9fadda-fdf6-4b6a-a22d-01d5299be33b",
"EffectiveDate": "2026-03-09T10:27:02.5998053-07:00",
"StateType": {
"StateTypeId": "812da01d-c6c6-47dd-b7fb-585bb7b0bd1c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a67c67b3-b0b2-4b29-8ad9-e021e7e1dbec",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4a2631a4-a758-43ca-9443-e76295da0572",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0abeff70-f34e-4c08-96b3-b3a1e61c9f69",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3aa8f77b-1c6a-4f45-8ab0-dd17013de2e9",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "22c167d2-bebe-4fbe-9643-eb01098030d5",
"EffectiveDate": "2026-03-09T10:27:02.5998053-07:00",
"StatusType": {
"StatusTypeId": "05fab87d-52bb-4b87-adda-c8c8c243b2b2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a67c67b3-b0b2-4b29-8ad9-e021e7e1dbec",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4a2631a4-a758-43ca-9443-e76295da0572",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7dcb081e-b6ae-411f-99d2-f5d442e1c7d3",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b6152cc5-6165-4d3d-9417-9517624cd30c",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ba5a36f9-de39-4435-8e33-9b69e52cd486",
"EffectiveDate": "2026-03-09T10:27:02.5998053-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "1c624368-041c-46ea-8fa5-047c8c0d82a3",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ab75593a-f74a-4c3a-af49-48e48b941f04",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "736989de-e865-4ccd-abfb-4eb88d437e01",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-09T10:27:02.5998053-07:00",
"MeasurementValueNeededDate": "2026-03-09T10:27:02.5998053-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2a0344a2-1b69-4eeb-ba83-97db2ab67f5c",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9291fe9b-1be7-4265-8fa3-afa4d0cab34f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5ffc004e-39cd-491e-899a-6506e198eab1",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-09T10:27:02.5998053-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "610815cf-04ff-4a8a-a425-6b49129447d5",
"CreateDate": "2026-03-09T10:27:02.5998053-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T10:27:02.5998053-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}