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": "49158cf0-d7b2-423c-893f-0b6216f6b726",
"Asset": {
"AssetId": "2e9a3583-dfd2-4175-9efd-ddbcd8d571c0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4215366a-ec71-4d38-b099-49110c2b3ab1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e6001cd9-ae20-4e77-ba8c-5db919b791cd",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "eacc4ad4-3900-47bc-bc63-1e0564655825",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-12T04:00:10.2326149-07:00",
"MeasurementValueNeededDate": "2026-03-12T04:00:10.2326149-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cacc0746-550d-42d9-b821-d98fdd4706a4",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7fa8dfcd-5aa9-4d10-a0e4-0a55d328b7ce",
"EffectiveDate": "2026-03-12T04:00:10.2326149-07:00",
"StateType": {
"StateTypeId": "aee6f3d6-ef9d-42c2-9853-872d1862e9b4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4215366a-ec71-4d38-b099-49110c2b3ab1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e6001cd9-ae20-4e77-ba8c-5db919b791cd",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a9a2f8d4-5b73-4196-9bbc-50f70444e538",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6b7b0839-bf33-4189-963b-2a4d7964ae2c",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "2be54375-a3a4-4974-9c32-b8a30a8504a9",
"EffectiveDate": "2026-03-12T04:00:10.2326149-07:00",
"StatusType": {
"StatusTypeId": "6bdfa4d8-f096-4e87-a8be-f8be25d16bed",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4215366a-ec71-4d38-b099-49110c2b3ab1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e6001cd9-ae20-4e77-ba8c-5db919b791cd",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a6217ac9-11b6-4ef4-9ce5-5abedd2e8018",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "624b2232-5aa9-45cc-a495-69f1e4c285b5",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "184b371d-bf57-4721-afca-129bd27e6210",
"EffectiveDate": "2026-03-12T04:00:10.2326149-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e449f7be-0677-424a-8f24-e39b86db9716",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "97d96072-3651-4c5e-81f8-9da7f6792727",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1d98a105-c926-4bd4-be1b-3e9b6fc2aab7",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-12T04:00:10.2326149-07:00",
"MeasurementValueNeededDate": "2026-03-12T04:00:10.2326149-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "13d020a5-5fcd-4b7d-85be-221fcb351093",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "bd53870b-b4b5-42bb-b3b9-382b9c1ee25d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d2200703-d82f-48d5-ba6d-25230655462e",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-12T04:00:10.2326149-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6a65ef67-9d93-4471-9c5b-2cf1c5bd69c7",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-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": "04063270-a8b9-45b4-b875-725da1724caf",
"Asset": {
"AssetId": "a7ef0984-0e70-4c50-9276-7b53ea932114",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4e585041-bcc8-4166-b012-44ae71f6e134",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4cfa5f2f-d098-44e0-a7d3-98121680d4b1",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e4797879-246a-4a52-a655-4ed5a138104d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-12T04:00:10.2326149-07:00",
"MeasurementValueNeededDate": "2026-03-12T04:00:10.2326149-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2609602-9c29-48b3-8922-c9ab53e5da4c",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4cfedfff-ffaa-4eeb-a152-5d2c46b3d9e8",
"EffectiveDate": "2026-03-12T04:00:10.2326149-07:00",
"StateType": {
"StateTypeId": "a70907ec-e4bb-4fd6-8ea5-9a83da0e963e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4e585041-bcc8-4166-b012-44ae71f6e134",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4cfa5f2f-d098-44e0-a7d3-98121680d4b1",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "493950dc-f972-44ba-81e6-f2e1624b8c43",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c0b1dd50-4351-40ab-90d2-9a2366239bd2",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b771db50-0e62-42ba-8745-bc193e6f86cb",
"EffectiveDate": "2026-03-12T04:00:10.2326149-07:00",
"StatusType": {
"StatusTypeId": "0ada40d7-53e6-43a9-a246-7dbea730bb6a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4e585041-bcc8-4166-b012-44ae71f6e134",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4cfa5f2f-d098-44e0-a7d3-98121680d4b1",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a63f0392-84f1-42e6-9de4-e29cc5ab1402",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1986e0e9-060e-42a4-9284-16480b523fea",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "01a3806b-c538-4475-88cb-6eedef3f2a90",
"EffectiveDate": "2026-03-12T04:00:10.2326149-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4fd7ddc6-17c1-4d47-a18b-6b560bb0cc12",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "64604cc8-ec14-411e-80c4-42b612477f57",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b9292edb-f454-423e-82d2-c392867d5f25",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-12T04:00:10.2326149-07:00",
"MeasurementValueNeededDate": "2026-03-12T04:00:10.2326149-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1825aacd-548c-495b-80ff-302f977702ff",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f266c219-f33e-4bfe-b3fc-f3bbe4f9ea72",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1fab3a64-19da-48d2-9f77-8d942df4446e",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-12T04:00:10.2326149-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7520293a-8206-447b-8e4a-862880b4a2f9",
"CreateDate": "2026-03-12T04:00:10.2326149-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-12T04:00:10.2326149-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}