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": "bdc3089e-3396-4c51-bea5-e95a67c71847",
"Asset": {
"AssetId": "5e45aa41-3b2f-4430-80e4-ece10c849266",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7ea02dc2-1f52-4ed6-9619-b49b78e7a494",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b7247f13-beed-423b-9e5b-d07069762b16",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d4a64312-1c43-4296-94c6-1b83b9bcc1d4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-31T20:33:57.0784397-07:00",
"MeasurementValueNeededDate": "2026-03-31T20:33:57.0784397-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c3c619f6-d01b-4c46-9d49-b3f87fe85889",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c237538c-a920-48a9-8216-72e14abdff4d",
"EffectiveDate": "2026-03-31T20:33:57.0784397-07:00",
"StateType": {
"StateTypeId": "b27040c4-ffeb-4fbf-977c-707786b9fd7f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7ea02dc2-1f52-4ed6-9619-b49b78e7a494",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b7247f13-beed-423b-9e5b-d07069762b16",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e06b4334-b924-4ddd-b6ae-b9550e0f56d1",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8b3ad505-ff7b-4f68-9615-3a785eba95c0",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7098dd55-1a1f-40ff-a48b-8b211ef2c7b4",
"EffectiveDate": "2026-03-31T20:33:57.0784397-07:00",
"StatusType": {
"StatusTypeId": "9f307063-6119-4289-bddb-8661074f5b54",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7ea02dc2-1f52-4ed6-9619-b49b78e7a494",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b7247f13-beed-423b-9e5b-d07069762b16",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "0be6a544-0e00-47e6-a49f-57305ffef60d",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "641d4217-aabf-4447-9828-e26a55ec8598",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "953206c5-c02c-4a5b-bced-e90fe61b4fa2",
"EffectiveDate": "2026-03-31T20:33:57.0784397-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a06d5035-dfe6-4684-9cc3-f94cb6d458fb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5644092b-028a-4a73-8224-47cdff0a3a86",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ac39e4db-476a-4f6f-b030-7743db74b2e8",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-31T20:33:57.0784397-07:00",
"MeasurementValueNeededDate": "2026-03-31T20:33:57.0784397-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d82b7f2b-2952-424c-8f7b-0ab0db1e8043",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "7fe0e726-a311-4bfe-ac59-2ed3e72ecded",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1209441d-ba5f-42b1-b497-e542854e8b13",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-31T20:33:57.0784397-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ef295687-9a08-4887-9c87-b9a9ee2e0fac",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-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": "122e5f61-245f-42f1-9ee1-d9704da2c349",
"Asset": {
"AssetId": "2887cb42-46ff-4374-b3ce-c65e4e4fa2d1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ca63618a-f3b1-4986-9787-8fc698d89ff9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c918c1bc-e8ca-403f-8fde-97056eacc7ca",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7369ecd7-23ca-49a9-ae6b-5b65e79a9547",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-31T20:33:57.0784397-07:00",
"MeasurementValueNeededDate": "2026-03-31T20:33:57.0784397-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7e5d21b3-e168-48b9-9ae4-45092c46e145",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7dc0817a-ab4b-4735-b04f-9a517324c4e7",
"EffectiveDate": "2026-03-31T20:33:57.0784397-07:00",
"StateType": {
"StateTypeId": "0b22715e-ed39-4383-b8b2-c3aee7577abe",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ca63618a-f3b1-4986-9787-8fc698d89ff9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c918c1bc-e8ca-403f-8fde-97056eacc7ca",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "cf502bcc-71cd-44e3-9171-482b99d95264",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "99e3897a-ff1c-45c6-9bca-1ba08b276324",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "832a7a16-59cc-4632-94d6-6461f30dac4f",
"EffectiveDate": "2026-03-31T20:33:57.0784397-07:00",
"StatusType": {
"StatusTypeId": "db513d8e-e57f-45cf-ba6d-1347c4b4f031",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ca63618a-f3b1-4986-9787-8fc698d89ff9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c918c1bc-e8ca-403f-8fde-97056eacc7ca",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ecb17f65-af85-4c44-935a-d9e36294fbfa",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "38eec0a4-0766-438c-92a2-bc48c530c14b",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "948b848a-de93-4950-8c70-90b7b05f13ce",
"EffectiveDate": "2026-03-31T20:33:57.0784397-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "7c64f332-9501-4208-b61d-6d8d4e66b9f8",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "33e6ab5e-f627-46c0-9d7a-266375d64f82",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6eb317d6-c15f-4a79-9978-0fc6f100b614",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-31T20:33:57.0784397-07:00",
"MeasurementValueNeededDate": "2026-03-31T20:33:57.0784397-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ba3fd779-b1a9-4842-815e-90372007665a",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "10442d2b-f1db-4208-8e38-bc6e66fb62ac",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "90209646-6b1f-434e-b7dc-1474ea388d6b",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-31T20:33:57.0784397-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a78278c8-c9a6-4e2a-b9d8-01f11e73096e",
"CreateDate": "2026-03-31T20:33:57.0784397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-31T20:33:57.0784397-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}