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": "eeeecb2b-0de3-4722-a022-e7dde3bb6ea6",
"Asset": {
"AssetId": "36e8bf76-07db-49f7-b54f-e5e8212ac3aa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "54877a0e-1316-48d7-b3a7-fcd7ce66d51e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "94c9e710-a9b3-456d-8cd1-cd051fa2285f",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "1bc4ffa0-d073-45ec-9b8e-4b0caa797374",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-16T09:06:07.0197604-08:00",
"MeasurementValueNeededDate": "2026-02-16T09:06:07.0197604-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "05bef02d-3c87-49fb-ae22-c76b2ff83784",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f05886b1-24d9-4cb5-8611-ffd0efc2088e",
"EffectiveDate": "2026-02-16T09:06:07.0197604-08:00",
"StateType": {
"StateTypeId": "117a9919-34b8-4311-9389-a3b88ea45371",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "54877a0e-1316-48d7-b3a7-fcd7ce66d51e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "94c9e710-a9b3-456d-8cd1-cd051fa2285f",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "097fadb6-5395-4fc7-86a2-70848bc7256e",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "384df74a-0369-476f-98b1-3b35e8605724",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5279a038-9a75-4e61-97cd-3fff762c5fc3",
"EffectiveDate": "2026-02-16T09:06:07.0197604-08:00",
"StatusType": {
"StatusTypeId": "d63ded42-fcee-42b1-b827-e6393bf16332",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "54877a0e-1316-48d7-b3a7-fcd7ce66d51e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "94c9e710-a9b3-456d-8cd1-cd051fa2285f",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "719799ac-21a8-4b94-9963-ea1ba30b91c0",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8bb44924-013f-4beb-aa6c-8f393d311657",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "35669d7e-0ee4-4d93-b798-e7a8a99c56c8",
"EffectiveDate": "2026-02-16T09:06:07.0197604-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "f90eadaf-ee25-4865-baa7-07cef6409bea",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a57f79e9-9a32-4dcc-b1ed-d40e1bedec58",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d03a249f-1765-4179-9780-43fc882ed041",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-16T09:06:07.0197604-08:00",
"MeasurementValueNeededDate": "2026-02-16T09:06:07.0197604-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "00c235c5-2c3d-46b9-919c-542cae2133af",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "12295b3a-474d-404e-a37f-4dd1c816f5c4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cdc8664e-d160-4d48-8888-41933a02dd3f",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-16T09:06:07.0197604-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "53944e35-15fa-48c9-a219-8eb3d441034a",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-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": "797243d9-05d2-45fb-9c73-b0c19e8b9907",
"Asset": {
"AssetId": "1b043234-5a34-401e-8adf-72ade14ddfbd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "165db313-088c-4636-a238-6c038c26e3e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5bb7dba2-6d74-42ef-b693-dbf7b0f499a5",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a23d1de2-e975-40fd-9d95-3e7857328d05",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-16T09:06:07.0197604-08:00",
"MeasurementValueNeededDate": "2026-02-16T09:06:07.0197604-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "78f2420a-6e1b-4104-8762-c43f49bf481a",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "15ab1197-82fe-4b50-9094-351c09407c9e",
"EffectiveDate": "2026-02-16T09:06:07.0197604-08:00",
"StateType": {
"StateTypeId": "6543bc74-26f0-423e-973b-41e1b3cae0dc",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "165db313-088c-4636-a238-6c038c26e3e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5bb7dba2-6d74-42ef-b693-dbf7b0f499a5",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6b239b1b-97b0-412f-b46f-2dfdd0dd1ce4",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bf1eb969-c609-44de-b7ab-b8757d702788",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7e6ea585-9c2d-4a96-8240-df7e77179a97",
"EffectiveDate": "2026-02-16T09:06:07.0197604-08:00",
"StatusType": {
"StatusTypeId": "f32fa462-4d19-47bb-9ebe-8ed54f50ab1d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "165db313-088c-4636-a238-6c038c26e3e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5bb7dba2-6d74-42ef-b693-dbf7b0f499a5",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fc1e994f-82fd-4a15-a0d9-05bf4bdc4340",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "10e32844-9d2b-4f86-b797-c746969d6383",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "40661552-a231-474d-87b0-878ce5a10830",
"EffectiveDate": "2026-02-16T09:06:07.0197604-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "6c81011b-bcf6-465c-82e0-d20b6e911614",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "52deee4a-d004-47f9-a20a-9203dff99784",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3b7ef6aa-2825-4ebe-817a-59aa52c385c7",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-16T09:06:07.0197604-08:00",
"MeasurementValueNeededDate": "2026-02-16T09:06:07.0197604-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5dd90abc-bf39-4819-b48f-4c7e253ff543",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f5f3b36f-cdf2-420e-827d-7a0a6ca3ce83",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aa24303f-a153-4808-8f95-03d952af9313",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-16T09:06:07.0197604-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f0833b58-86a3-436b-91ce-9aa7659ed30d",
"CreateDate": "2026-02-16T09:06:07.0197604-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-16T09:06:07.0197604-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}