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": "8cefc1ed-a077-4093-b945-d27ace1a1349",
"Asset": {
"AssetId": "c6d7b252-2251-4703-b5b4-f0bf19e7c640",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1c781e69-6f1c-462a-bb32-9610133ba6bf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c0f35d4e-82a6-4679-a9b8-7015b92ef5f4",
"CreateDate": "2026-09-22T06:21:56.6484611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T06:21:56.6484611-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d158ab46-20bd-4f45-8761-ec044d1cb13c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-22T06:21:56.6484611-07:00",
"MeasurementValueNeededDate": "2026-09-22T06:21:56.6484611-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5e7bfb52-fd0d-4b1e-a441-dfb2e5cb4fa3",
"CreateDate": "2026-09-22T06:21:56.6484611-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T06:21:56.6484611-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e91dfa14-8db6-4784-b3ef-aa727516f432",
"EffectiveDate": "2026-09-22T06:21:56.6484611-07:00",
"StateType": {
"StateTypeId": "a7eb0b23-4307-4171-9179-dfb04f2633da",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1c781e69-6f1c-462a-bb32-9610133ba6bf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c0f35d4e-82a6-4679-a9b8-7015b92ef5f4",
"CreateDate": "2026-09-22T06:21:56.6484611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T06:21:56.6484611-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "709b91c5-c487-471f-9fc7-aa4094395236",
"CreateDate": "2026-09-22T06:21:56.6484611-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T06:21:56.6484611-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9781e0f2-55b8-49d7-b097-487cca6fee50",
"CreateDate": "2026-09-22T06:21:56.6484611-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-22T06:21:56.6484611-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1bf7a627-0585-440b-b9d3-8f16eddefb62",
"EffectiveDate": "2026-09-22T06:21:56.6484611-07:00",
"StatusType": {
"StatusTypeId": "ab5dea10-f077-4f6c-8e9b-66e77fbda4e9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1c781e69-6f1c-462a-bb32-9610133ba6bf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c0f35d4e-82a6-4679-a9b8-7015b92ef5f4",
"CreateDate": "2026-09-22T06:21:56.6484611-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T06:21:56.6484611-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a57bdb03-e24e-47cd-aac7-cf048309fe93",
"CreateDate": "2026-09-22T06:21:56.6484611-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T06:21:56.6484611-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "105b204c-efa0-49cc-9a91-9d8a354a56ad",
"CreateDate": "2026-09-22T06:21:56.6484611-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-22T06:21:56.6484611-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e6f4a408-9671-490e-8f35-e9fecbeafd49",
"EffectiveDate": "2026-09-22T06:21:56.6484611-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "315e0e68-ed7d-457d-a763-e0f911412e44",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0bfdf1d9-4219-462c-b2d5-8070d7883d7e",
"CreateDate": "2026-09-22T06:21:56.6640877-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T06:21:56.6640877-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2a86e9d1-28a1-438d-a449-6f5bd8951bc7",
"CreateDate": "2026-09-22T06:21:56.6640877-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-22T06:21:56.6640877-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-22T06:21:56.6640877-07:00",
"MeasurementValueNeededDate": "2026-09-22T06:21:56.6640877-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "460d55eb-365a-4576-9a81-f7457a71b0b4",
"CreateDate": "2026-09-22T06:21:56.6640877-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T06:21:56.6640877-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9d2d60b9-a64f-44ea-b9f8-9cf855d52d24",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ba78881a-519a-4906-b723-d3066434f9b9",
"CreateDate": "2026-09-22T06:21:56.6640877-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T06:21:56.6640877-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-22T06:21:56.6640877-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c811e76e-04a8-424a-9c3e-736d56c317f6",
"CreateDate": "2026-09-22T06:21:56.6640877-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T06:21:56.6640877-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": "91c251ee-fed6-46ab-a442-71632b940cef",
"Asset": {
"AssetId": "dbfce631-710f-4cc9-be5d-1b31f47ecac4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "70140b36-8313-48e0-aa02-7590ed5f0cd9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30ec4f21-2c26-409b-8a40-a97e5aaa6979",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d332f5fe-6157-4697-860c-bed2ec625668",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-22T06:21:57.0390352-07:00",
"MeasurementValueNeededDate": "2026-09-22T06:21:57.0390352-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "929828af-b902-4ae8-867f-447c1dfc5ba5",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ceb33b85-7f25-4293-bbf4-cffc9efd7054",
"EffectiveDate": "2026-09-22T06:21:57.0390352-07:00",
"StateType": {
"StateTypeId": "f25b4725-35e4-4def-bf91-97bd7688faa3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "70140b36-8313-48e0-aa02-7590ed5f0cd9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30ec4f21-2c26-409b-8a40-a97e5aaa6979",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "97a83b0b-c2b2-4521-97c2-7b63bdc917c6",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ac902e26-7a13-45be-afdf-91e1af24297c",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f6593f28-f366-4eb2-a4af-5c8311fd8ddb",
"EffectiveDate": "2026-09-22T06:21:57.0390352-07:00",
"StatusType": {
"StatusTypeId": "9afa3123-753e-44dd-8718-53dbd189c2a1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "70140b36-8313-48e0-aa02-7590ed5f0cd9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "30ec4f21-2c26-409b-8a40-a97e5aaa6979",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "50ea070b-3ee2-429b-abb9-9f35d60b03f3",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c789b318-c742-47c1-b728-06cbbccb1b7a",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5b607197-241d-4cdb-80b9-fd07815d68c1",
"EffectiveDate": "2026-09-22T06:21:57.0390352-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "42e514c8-fbd3-47db-82a8-deaa0383afcb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1d4f31fd-b499-4ace-9c53-c4f555a92534",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2b137192-164e-45ef-b823-73d946a1305f",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-22T06:21:57.0390352-07:00",
"MeasurementValueNeededDate": "2026-09-22T06:21:57.0390352-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "db61bc4c-3b7c-4548-b917-499cdd440a03",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "79e3baea-8b74-4fda-86f2-9eb42be69d4d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ccb60b7c-768b-4bba-aa93-6b84639dd812",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-22T06:21:57.0390352-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "11cdf7fc-0680-4d48-8d47-f5cf3a23ce2f",
"CreateDate": "2026-09-22T06:21:57.0390352-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T06:21:57.0390352-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}