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": "61f01b67-ca2f-46fb-94d2-71cf3cda9f8c",
"Asset": {
"AssetId": "33c3adb2-42aa-4917-9ceb-778a7a5a0ae4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "820d6de5-4261-4a82-9309-355c4132c50e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10782170-9197-4168-a54f-3ce7729d80b3",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7428f83a-114b-42ba-ade5-d24ccaf21476",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:50.0819676-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:50.0819676-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cdb24925-f6bb-4398-a00d-4bbd87eba3de",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e90d603f-9b61-483e-a86d-590f1ae836b0",
"EffectiveDate": "2026-11-22T14:12:50.0819676-08:00",
"StateType": {
"StateTypeId": "04ee59a2-4f2a-48e1-8ff0-8f92bb4677ab",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "820d6de5-4261-4a82-9309-355c4132c50e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10782170-9197-4168-a54f-3ce7729d80b3",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "eda181ee-a48c-40b9-8e1b-fabb34623012",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9523b464-5da8-4e7d-b745-fe1cdb0ede0c",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9169ddf1-d23f-4fe9-a728-904af506c84c",
"EffectiveDate": "2026-11-22T14:12:50.0819676-08:00",
"StatusType": {
"StatusTypeId": "851a01c9-bacb-463b-b29f-1afdd3538d63",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "820d6de5-4261-4a82-9309-355c4132c50e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10782170-9197-4168-a54f-3ce7729d80b3",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6b3eebf6-fc55-495b-9cc3-3fd44d9374a4",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0f8a4053-8533-4ffd-bb6e-5bf657c570e5",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a9921e8b-2a9a-437e-923c-035e4c602da7",
"EffectiveDate": "2026-11-22T14:12:50.0819676-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "4b322ae9-7d6f-4c78-85a7-61eb735776ed",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "528758c7-b10a-4298-a844-2f3f7aca9565",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2bd592fe-1860-4697-af5f-111c68136017",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:12:50.0819676-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:50.0819676-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e81e889a-214d-4352-bb8b-b3a03aac6b17",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "38d67f44-731d-4461-8db3-5093500916c2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1277d8fd-3a35-4ede-b626-795e7703d6c8",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-22T14:12:50.0819676-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d2fb28c1-b00e-4801-8580-fec841d640cf",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08: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": "ba9cdd5d-1e10-415e-a0df-d44c794b95ef",
"Asset": {
"AssetId": "aef5a2eb-26d2-41e5-a626-e70d4907a8b6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a2b302e0-33a5-4d95-a124-cdb029f6b14c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72eb6098-afea-4380-84af-5d78465a7a0d",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7130b47a-fd66-47af-a2b7-9521e2108a1a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:50.0819676-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:50.0819676-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ca116521-ac1d-4ae0-955b-54720d4ddb65",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "6adbd896-97b6-4fe3-90b5-9cc4cf63b3a2",
"EffectiveDate": "2026-11-22T14:12:50.0819676-08:00",
"StateType": {
"StateTypeId": "059a1a0f-a714-4837-811f-45cf73155eae",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a2b302e0-33a5-4d95-a124-cdb029f6b14c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72eb6098-afea-4380-84af-5d78465a7a0d",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "600de45b-8896-47e1-8b1d-73268aa98697",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5729d9c9-93f7-4571-9ed6-52568841565a",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4f1335dd-984c-4005-8033-78e3264990af",
"EffectiveDate": "2026-11-22T14:12:50.0819676-08:00",
"StatusType": {
"StatusTypeId": "af7a48b8-60f3-4abd-a21c-1c2399931e9d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a2b302e0-33a5-4d95-a124-cdb029f6b14c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "72eb6098-afea-4380-84af-5d78465a7a0d",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ca76091f-ab82-4dc4-a6a8-f31f01a7ec6d",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d4eae25b-ada6-4c07-be36-d6abb5b93c26",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "32777e09-20c7-4d23-8793-0788aa11919b",
"EffectiveDate": "2026-11-22T14:12:50.0819676-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "5d282c17-09a9-4d5b-8bd7-b4679ef2a8e8",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8af3cb12-04b0-421b-8a45-2da32c657393",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "94711c4d-68c1-454a-af07-490ed591df70",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:12:50.0819676-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:50.0819676-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1953e874-2204-4a0b-865d-47682ca87dab",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b65381e6-358d-4fa4-b245-03bf5c568c81",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f8a3b5ef-ad35-473b-88dc-ca69fa4df654",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-22T14:12:50.0819676-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6495f037-07d8-4362-8adb-56ecb0f70d10",
"CreateDate": "2026-11-22T14:12:50.0819676-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:50.0819676-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}