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": "4d6d6691-00d6-4e79-b542-ed37c58c62bb",
"Asset": {
"AssetId": "8b1a88c1-26aa-4077-b15e-f3987eb3781c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "54eca18e-33c3-4743-9ebe-c7dd1a1cb68e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1ffd849c-19d4-4bcd-9bdb-feb0d5e9b6b7",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "86033f34-10e1-447b-b14f-8ea6bf1d5f1d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:11.9150956-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:11.9150956-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bdb03aa4-e462-4886-84d0-7aec38e5f488",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e7b0feca-3aa7-467a-9432-d66582f70797",
"EffectiveDate": "2026-09-26T13:57:11.9150956-07:00",
"StateType": {
"StateTypeId": "8e654cea-2cf2-4a3f-974a-2247a9e359fb",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "54eca18e-33c3-4743-9ebe-c7dd1a1cb68e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1ffd849c-19d4-4bcd-9bdb-feb0d5e9b6b7",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "43ecd4eb-c2a3-4950-b03e-de3c89be90f6",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3f4ac19a-fe33-4ec4-98ff-939139e71ef8",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "555c937f-544c-44ae-952f-32a4f4abc283",
"EffectiveDate": "2026-09-26T13:57:11.9150956-07:00",
"StatusType": {
"StatusTypeId": "92244717-e51a-42b5-a1ec-e6b0931ac51e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "54eca18e-33c3-4743-9ebe-c7dd1a1cb68e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1ffd849c-19d4-4bcd-9bdb-feb0d5e9b6b7",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c7dbe40e-ea12-4dbb-9582-22bf32909eda",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9433ac1a-c387-409e-b681-86a96d8f7426",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "237e5e1c-2bae-40d4-a68a-0eef21a8ba20",
"EffectiveDate": "2026-09-26T13:57:11.9150956-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "45cdd262-acf9-41dd-8563-aaec501bc682",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a785a0bd-3e0e-43ed-9e04-c31426dcf52c",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cc6f4024-c964-47a1-98d6-7192c150b80b",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-26T13:57:11.9150956-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:11.9150956-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "efa30b41-2cf6-4d87-b17e-0e7bb1c041c1",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "498a73cb-3eac-498f-ad1e-7b77f1e32628",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "18a00302-dcfe-4c5c-a408-36b16476bb31",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-26T13:57:11.9150956-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "04dc65f9-0f92-4aa6-a63e-807d0596d738",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-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": "ab31aeeb-faed-4778-87f7-3c5c4ca32ce4",
"Asset": {
"AssetId": "9e337b72-4f73-4285-adf3-453f5ccb7ac9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a6ec2a60-ecfb-4405-9347-1965c3c90455",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4a3cb930-7b98-48ef-9cd2-67507e875891",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "06528f55-9001-4b0e-9d6e-a071f24b2564",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:11.9150956-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:11.9150956-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "26271668-b324-4c62-93cd-c9efa4f706b5",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dfe320c3-3164-4ab0-9aa7-01442ae8d5d3",
"EffectiveDate": "2026-09-26T13:57:11.9150956-07:00",
"StateType": {
"StateTypeId": "0d0fba87-6f75-4403-92c9-b0aaa52327f0",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a6ec2a60-ecfb-4405-9347-1965c3c90455",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4a3cb930-7b98-48ef-9cd2-67507e875891",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "5d4ed129-9577-418e-8903-16370fd5e42c",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f6e6783d-7bd5-482b-a8e3-2d115a2e1d0b",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b2ec1e05-a3c0-4d54-9199-a9f03c5c755e",
"EffectiveDate": "2026-09-26T13:57:11.9150956-07:00",
"StatusType": {
"StatusTypeId": "86617100-802d-4183-8c39-784535885bf7",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a6ec2a60-ecfb-4405-9347-1965c3c90455",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4a3cb930-7b98-48ef-9cd2-67507e875891",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1c31fd02-c538-4150-a6ce-57a25025c9ca",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "048b550a-05b8-412f-a5b3-f0e737f027b5",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "16c9b70b-44c8-4932-b33c-3767d6acf8c9",
"EffectiveDate": "2026-09-26T13:57:11.9150956-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "2b6053c9-d5fb-4841-b8e4-f605867671c7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8dd5bd3e-0009-401d-9882-c9a2587f4aee",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ce2dc637-b859-4ef5-8bc8-01f6b6027c17",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-26T13:57:11.9150956-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:11.9150956-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fe019183-25cc-4d5d-8011-6482c769b8ba",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "177d98cb-5a2a-4b72-91f9-3b611eea7874",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "26698916-085f-4ac2-90b4-051928266fdb",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-26T13:57:11.9150956-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "303e8781-394f-4a59-90fe-815684725158",
"CreateDate": "2026-09-26T13:57:11.9150956-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:11.9150956-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}