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": "92a3a7aa-a476-4ed6-a98f-8438f8c25ce7",
"Asset": {
"AssetId": "6cdc5d85-1c45-4001-be7a-f300237e2051",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "27617dd3-b4c0-44ab-a40e-c36da91ac718",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "995c3d00-1e7a-4620-9bf5-f7462486ad3d",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "87527f04-997d-45e6-a4c0-6cba668c8856",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T20:45:07.4397129-08:00",
"MeasurementValueNeededDate": "2026-02-02T20:45:07.4397129-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6651b65a-18ee-47d9-9e63-6a4b123fe6a1",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a83841d1-1d69-4ca7-9cc5-d746ba123780",
"EffectiveDate": "2026-02-02T20:45:07.4397129-08:00",
"StateType": {
"StateTypeId": "219aea36-5369-46cc-aec1-0d2c7f23bfeb",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "27617dd3-b4c0-44ab-a40e-c36da91ac718",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "995c3d00-1e7a-4620-9bf5-f7462486ad3d",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c6be98da-660e-4cc3-96ba-0c32b78a5547",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e2f781fd-ac60-4ab3-9864-a5427f50a2ce",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "06dd1fa7-126c-4505-9a5a-a5167dbcdf07",
"EffectiveDate": "2026-02-02T20:45:07.4397129-08:00",
"StatusType": {
"StatusTypeId": "1ac4312d-5779-4f22-8994-e2d9ebe9cfb4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "27617dd3-b4c0-44ab-a40e-c36da91ac718",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "995c3d00-1e7a-4620-9bf5-f7462486ad3d",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "249112f2-25f9-49bb-89f9-5d235d16bff8",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f257899f-b107-43ab-9a6a-6d9a6d2de3ed",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "646eb177-4512-4ee5-b410-ab8700b6c2cc",
"EffectiveDate": "2026-02-02T20:45:07.4397129-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d681906a-9f30-4bd8-b51e-da85be004371",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d4c4a70f-0935-421f-8523-39c249cce6b1",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6eeb192d-4688-487d-b99c-f233212545fd",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T20:45:07.4397129-08:00",
"MeasurementValueNeededDate": "2026-02-02T20:45:07.4397129-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5f4876bf-c4bd-4812-bd97-d9dfab98ec2f",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c1e6ed58-748a-41f6-91db-baef9eabe080",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6a033e7c-1479-4c90-a948-f4b85eb486dd",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-02T20:45:07.4397129-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "228ae118-2b66-47a8-8082-cd44c24d9567",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-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": "f02665e4-0ec4-47dc-b157-f7d03ecad93a",
"Asset": {
"AssetId": "30bb7f54-dd12-4685-925f-f6d670086307",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "521c81d9-791d-4e8f-adbb-903fd6e833c5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ad3a7168-460c-4eb4-b974-533315bf7777",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "025687d4-eff3-45c4-9d7f-a23e03bdb46d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T20:45:07.4397129-08:00",
"MeasurementValueNeededDate": "2026-02-02T20:45:07.4397129-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d43bf86b-84a9-4c62-b656-50a92a8ce7c2",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a9bd8308-176a-47d9-8591-8d61a7d773a2",
"EffectiveDate": "2026-02-02T20:45:07.4397129-08:00",
"StateType": {
"StateTypeId": "0d28934f-7420-4281-9346-e06eb1d018b6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "521c81d9-791d-4e8f-adbb-903fd6e833c5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ad3a7168-460c-4eb4-b974-533315bf7777",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fedadea6-ab09-427a-bce6-0552055d42c8",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fb3a8411-96e5-4f26-ad84-7a9e953c6840",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6d9d62a2-265d-4e81-8d8d-53cc9c9dabad",
"EffectiveDate": "2026-02-02T20:45:07.4397129-08:00",
"StatusType": {
"StatusTypeId": "d78a2583-9c28-47e1-a0bc-beefd699270e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "521c81d9-791d-4e8f-adbb-903fd6e833c5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ad3a7168-460c-4eb4-b974-533315bf7777",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "0097bee2-edc5-430f-8fc5-8f7fef287cbb",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "21ff7212-a344-4c1d-8a6a-6d4532729be4",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e63d20f9-8a89-4edd-8242-762d49af82f4",
"EffectiveDate": "2026-02-02T20:45:07.4397129-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "cf69fb28-9c3e-435d-827f-c80714b255b0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8f40445e-91bd-4a0b-b340-80d2a2c0fb24",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "11504b27-d59a-41b2-b170-7c250ce45f33",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T20:45:07.4397129-08:00",
"MeasurementValueNeededDate": "2026-02-02T20:45:07.4397129-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "02e378f6-4eb5-4830-b252-f01c4d12484b",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b4065e37-eb04-4c33-a10f-6d17c2895d78",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1839a86e-2662-4074-971c-79df60255454",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-02T20:45:07.4397129-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0cc27a8a-c984-48c8-b3c4-689c9142cdca",
"CreateDate": "2026-02-02T20:45:07.4397129-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T20:45:07.4397129-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}