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": "9ce955b6-3524-48af-b876-daf00d5ed068",
"Asset": {
"AssetId": "10fb94a8-6f67-46e4-9d42-221effd2b6b1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "79e809d3-be70-4242-8fc0-12c9d5f0805b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d26bf0f1-1026-44db-95b0-98fa3c2e21ae",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "1d81d65b-82f4-44a6-9c18-8a128fee5ad4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-28T08:06:30.8745815-07:00",
"MeasurementValueNeededDate": "2026-03-28T08:06:30.8745815-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9452b2c9-ced3-4f5b-8d84-8d8b243f3dae",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b87a6b28-951e-4dd9-b5bf-36a20a0d7e50",
"EffectiveDate": "2026-03-28T08:06:30.8745815-07:00",
"StateType": {
"StateTypeId": "4970786d-46f4-4a37-803b-6bd8b8b5a51f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "79e809d3-be70-4242-8fc0-12c9d5f0805b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d26bf0f1-1026-44db-95b0-98fa3c2e21ae",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f0ce2847-4ecd-48f6-82c8-f177dfc48cca",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0966d8f4-a891-47a8-a79b-19ff1fb7e355",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e78f8c22-16e7-4b50-ae45-4ced5f60a908",
"EffectiveDate": "2026-03-28T08:06:30.8745815-07:00",
"StatusType": {
"StatusTypeId": "6eb4f226-6066-4d1c-a691-b6b62d820d77",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "79e809d3-be70-4242-8fc0-12c9d5f0805b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d26bf0f1-1026-44db-95b0-98fa3c2e21ae",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1b93b476-c8f5-4ba9-b179-c20586a21ad9",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2e787901-cfb8-486f-87de-f13e8a7f5902",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "10ef2a6b-6d58-45e5-aa64-c590efc00306",
"EffectiveDate": "2026-03-28T08:06:30.8745815-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "db3d734a-9b09-4f70-a0c3-a0ff4308a61d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c0cd68b6-119c-49f1-853a-7f13edd5d439",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3bbd7499-51bc-4d74-b984-5d9696d8089c",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-28T08:06:30.8745815-07:00",
"MeasurementValueNeededDate": "2026-03-28T08:06:30.8745815-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "762cbb08-207c-4c9f-8e77-da8cafe7f547",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "00ff4444-d3f4-4c15-8f48-55acc5b7b83c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c59f20c2-9019-497b-a00b-57e48e588dab",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-28T08:06:30.8745815-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8129eadd-99f9-4bc4-ad88-57bb0ae483e2",
"CreateDate": "2026-03-28T08:06:30.8745815-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-28T08:06:30.8745815-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": "8dd216f5-5129-4aec-bc84-01dddf43d3b9",
"Asset": {
"AssetId": "34d00495-965f-4861-ba7d-b30bcca7daca",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9798ede2-5384-46b8-a51a-a9563f225522",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "779c244c-d47b-4e70-8ea8-1c360be0e79a",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ce1112e7-51cb-4125-bd3d-bae44e089d79",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-28T08:06:30.8902064-07:00",
"MeasurementValueNeededDate": "2026-03-28T08:06:30.8902064-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dbb770a6-a509-497b-a7a8-7156fa44a1df",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5bd21d68-7027-46df-9de3-2d67ce8eda23",
"EffectiveDate": "2026-03-28T08:06:30.8902064-07:00",
"StateType": {
"StateTypeId": "5194dbce-5dec-481e-85cb-9e6e4f0938b9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9798ede2-5384-46b8-a51a-a9563f225522",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "779c244c-d47b-4e70-8ea8-1c360be0e79a",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "933bd9f9-eb1a-4841-b2a8-c21739bac07e",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ca9786a4-c0d0-4e9f-80f6-f774cb440b63",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fdbeaf80-13e9-4257-89a2-b6b9f7e201eb",
"EffectiveDate": "2026-03-28T08:06:30.8902064-07:00",
"StatusType": {
"StatusTypeId": "2bacc78a-a465-4f57-a371-fcf4a8144d81",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9798ede2-5384-46b8-a51a-a9563f225522",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "779c244c-d47b-4e70-8ea8-1c360be0e79a",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "93bc8e31-69fc-4815-ad7f-52fee75d2f29",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ca5c0923-1d9e-4cc6-954d-954c8e7b1460",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "359fd74e-a133-4890-bb56-c378df74b3e0",
"EffectiveDate": "2026-03-28T08:06:30.8902064-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f6921a64-d092-422a-903d-49355d4e3c0d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "de3eb9e4-2825-4d6d-a043-ad00c3890d7c",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2914ecd7-9007-4022-af28-4622a1586c45",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-28T08:06:30.8902064-07:00",
"MeasurementValueNeededDate": "2026-03-28T08:06:30.8902064-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "28223a1c-3387-4f23-9fac-532f7e2b79ae",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "dd13be1b-16d7-4a9b-b257-4d772ce29e70",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d0da323c-d0d0-4a5c-86f5-2dd2747e7791",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-28T08:06:30.8902064-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bb619574-850d-46bc-872c-21122043a870",
"CreateDate": "2026-03-28T08:06:30.8902064-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-28T08:06:30.8902064-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}