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": "34443f4d-32c0-4597-8bc2-d9241dc4d7a3",
"Asset": {
"AssetId": "7825976e-1f44-4ca5-b834-6d109f366303",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "18211187-9917-444c-bb66-f7d340a6ca81",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ec3b2f93-7c4e-4b65-9249-ec2e57d01585",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "75e861f4-8f9b-4ef0-a1cc-9b9d1a4f9c7a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T23:39:27.9281477-07:00",
"MeasurementValueNeededDate": "2026-03-15T23:39:27.9281477-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ed8bff76-5c77-4ff1-81a8-f17a8daae357",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "cb4972c7-2669-481b-ad80-75caceb5722a",
"EffectiveDate": "2026-03-15T23:39:27.9281477-07:00",
"StateType": {
"StateTypeId": "82905242-98dc-44b0-a0d1-012a112300c5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "18211187-9917-444c-bb66-f7d340a6ca81",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ec3b2f93-7c4e-4b65-9249-ec2e57d01585",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "614b7012-8750-4e2b-a076-320621c21700",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d77603f6-4c11-473e-b5a8-e19231bfd55e",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e678076d-bbe9-496e-a090-80aa66e496d2",
"EffectiveDate": "2026-03-15T23:39:27.9281477-07:00",
"StatusType": {
"StatusTypeId": "7951a37e-4fdf-45be-9334-332ad6a4f40e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "18211187-9917-444c-bb66-f7d340a6ca81",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ec3b2f93-7c4e-4b65-9249-ec2e57d01585",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c7202e1b-4d12-4417-95f0-4ad49bff983b",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a6821309-bbe4-4c7d-9e2a-efbe1842dcde",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "af1cf601-f839-476d-8caa-e54cd9bd8ff9",
"EffectiveDate": "2026-03-15T23:39:27.9281477-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "ebec8bb8-af0b-4c89-9f7b-14c573bcd183",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "750f27ae-de10-43ac-8a77-fdeb32b12070",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0e3e5c97-def4-41ba-be85-28714873fe76",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-15T23:39:27.9281477-07:00",
"MeasurementValueNeededDate": "2026-03-15T23:39:27.9281477-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7aed3346-39a0-41f6-8fb1-88f7c1ce2923",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f99cb96a-dcfa-4899-9495-851c6ea0d923",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "75f93f4c-58eb-4177-9447-c9c201508f9c",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-15T23:39:27.9281477-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a3ca72a5-0fbb-432b-acf2-d0ed72d550ca",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-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": "eaf23326-6bd8-40d4-a11a-e032cb068b61",
"Asset": {
"AssetId": "ebaed081-1fe9-4382-8519-0b7a009279a8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ebf00dcf-30ea-47c1-8a06-0d6aa17579a5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6a66ff6e-575b-4b4a-9736-224c4150842e",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "359ce712-1af5-46aa-b9f4-7038c72f9133",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T23:39:27.9281477-07:00",
"MeasurementValueNeededDate": "2026-03-15T23:39:27.9281477-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2576c59-951c-44c9-a6e3-bad5f8cfc8bb",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7fbd066f-d9cf-4caf-81e5-167ab7643077",
"EffectiveDate": "2026-03-15T23:39:27.9281477-07:00",
"StateType": {
"StateTypeId": "18b7d7eb-5b14-4002-92df-247c4ce91c70",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ebf00dcf-30ea-47c1-8a06-0d6aa17579a5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6a66ff6e-575b-4b4a-9736-224c4150842e",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d3d01c72-5986-40db-b6e5-07e2c2505ecf",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2e0332b1-03c0-454a-a9e2-3f94cb796baf",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f44c6a8a-06ef-4837-9166-73bdc8c1c23a",
"EffectiveDate": "2026-03-15T23:39:27.9281477-07:00",
"StatusType": {
"StatusTypeId": "67a4c75f-a106-49c4-b962-2235d0ef03c6",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ebf00dcf-30ea-47c1-8a06-0d6aa17579a5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6a66ff6e-575b-4b4a-9736-224c4150842e",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "0179a8d9-b3d8-451e-b22d-b453294a8dc8",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "03da8f31-e680-4ada-8616-18f257c52929",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8ec2ae25-0deb-479a-9127-4253766f0930",
"EffectiveDate": "2026-03-15T23:39:27.9281477-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c9b36104-945f-42be-a5be-3b5d512961bb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "68a20c7c-eb79-4c65-8b1e-0aaa789aaaa8",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cf05b9f1-8414-4b24-8490-11a0d16980d0",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-15T23:39:27.9281477-07:00",
"MeasurementValueNeededDate": "2026-03-15T23:39:27.9281477-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "54c527c0-1fc6-4228-9bec-265a8e391a37",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "352b86d2-033c-455b-a455-32040818abd5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d9227d11-9ffd-42c5-b0e0-3202423b5fae",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-15T23:39:27.9281477-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a3c376a1-201b-4c2c-a843-0295854b2ca9",
"CreateDate": "2026-03-15T23:39:27.9281477-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T23:39:27.9281477-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}