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": "4405fa3d-6360-4df1-8c4d-18fa847dff91",
"Asset": {
"AssetId": "79fd47f8-7d86-46bb-903f-c725e06c5d63",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "db32199b-0279-4183-9799-056763a94646",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6d99bb15-78db-41e5-ac7f-e7bf85e7f39c",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "417603d1-d02b-4839-b35f-48491b1e705f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-21T15:19:08.2854429-07:00",
"MeasurementValueNeededDate": "2026-06-21T15:19:08.2854429-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "17c5e875-6155-457e-86a9-b4171e830f74",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "41bb2ad1-a6d8-45d8-8476-3a758837ee1c",
"EffectiveDate": "2026-06-21T15:19:08.2854429-07:00",
"StateType": {
"StateTypeId": "496a71b9-330b-4f61-9813-e4ea7d668b20",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "db32199b-0279-4183-9799-056763a94646",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6d99bb15-78db-41e5-ac7f-e7bf85e7f39c",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e2466475-5ee2-4f0e-8744-ec6be066b90e",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0d0a0f80-b9b3-4fcf-bf2c-b219575b8453",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "41361317-1da0-4eb3-9ebb-d4fae02f58d4",
"EffectiveDate": "2026-06-21T15:19:08.2854429-07:00",
"StatusType": {
"StatusTypeId": "3b680a52-00d7-4577-8431-3ea9c8ea5675",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "db32199b-0279-4183-9799-056763a94646",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6d99bb15-78db-41e5-ac7f-e7bf85e7f39c",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "99f99ebc-fa33-4e2a-973a-78119f6099b6",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ada3b63e-e4a9-40df-9b35-231368aadf06",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a1559bc0-452e-438c-b7fd-2cd6a40bc7e4",
"EffectiveDate": "2026-06-21T15:19:08.2854429-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "9b3b7d10-fb18-4d46-9580-04d5480c0c26",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f62d7c4f-6c4e-466a-a333-5f8154a448d5",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4d63a37c-a1d4-4002-93c0-cda54b8d22b2",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-21T15:19:08.2854429-07:00",
"MeasurementValueNeededDate": "2026-06-21T15:19:08.2854429-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b867187b-572e-40cc-8950-c69643a08f08",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "798744d2-8c95-4739-8d7c-f6ac50f23696",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "29f8d378-4fe7-44cf-b7e8-dd834f7219f8",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-21T15:19:08.2854429-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fd0d57d1-39dc-42ca-b444-c3abadedc7d6",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-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": "3079fc48-7ae3-4a0a-84d1-a50f9c2e13e3",
"Asset": {
"AssetId": "625276c2-e7a8-4420-b7fb-779e296f5957",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "83e63017-244e-4ad3-8e40-f3f2a332dd95",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "642e8564-6672-49bf-b7f2-366d55ace904",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "00dafd4e-cdf9-4021-8de5-daaf8bd88b7d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-21T15:19:08.2854429-07:00",
"MeasurementValueNeededDate": "2026-06-21T15:19:08.2854429-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "173c6cdc-d953-41dd-9df0-62f4cd25e1bb",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "54cfa04b-2150-49e1-ab1b-95d85949873a",
"EffectiveDate": "2026-06-21T15:19:08.2854429-07:00",
"StateType": {
"StateTypeId": "767bafe4-91df-4b5f-9896-b287c362bf4c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "83e63017-244e-4ad3-8e40-f3f2a332dd95",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "642e8564-6672-49bf-b7f2-366d55ace904",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0f1f2806-e609-452e-bef7-6f291cee6df8",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "669084d7-5c64-4894-822c-0e7a6f339658",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6e2745bd-a8b5-4080-a824-312e558858a5",
"EffectiveDate": "2026-06-21T15:19:08.2854429-07:00",
"StatusType": {
"StatusTypeId": "ef08de30-3203-40d1-a9b2-2fc73f10b662",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "83e63017-244e-4ad3-8e40-f3f2a332dd95",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "642e8564-6672-49bf-b7f2-366d55ace904",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2ed536eb-e187-4959-bac7-4a74679afa9f",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7f39b400-caeb-43d9-8065-8534cf3d709a",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b0a827d5-0203-4d1d-aa71-f0e8712cbd4f",
"EffectiveDate": "2026-06-21T15:19:08.2854429-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3f814391-c900-473d-acf3-48208c48f5c1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a42a73a3-65ee-49e4-a058-8ac927fed09e",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cf7286f2-255b-4d22-bb3a-b615d96955b2",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-21T15:19:08.2854429-07:00",
"MeasurementValueNeededDate": "2026-06-21T15:19:08.2854429-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bd62f6ea-17b1-412b-a589-23d86ad5385a",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4f95f0dd-b9ae-4345-b187-4eb1251938e4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "779fa90c-5e22-4500-87b5-7907e8f43b77",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-21T15:19:08.2854429-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "588c6baf-a327-4f34-a650-75049264a425",
"CreateDate": "2026-06-21T15:19:08.2854429-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-21T15:19:08.2854429-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}