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": "12ee354d-6591-43fa-a766-667a9cc6f9a1",
"Asset": {
"AssetId": "9a608b75-35cc-493c-a078-ad5a054acbd0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e7d2460f-e7d9-4499-a7e1-14ed7e67c8e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47206332-9522-4eb5-b19f-4d04e5e3db62",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8ac6df27-60b8-4e50-88da-bd9b64b4b971",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-02T10:22:11.5773284-08:00",
"MeasurementValueNeededDate": "2026-11-02T10:22:11.5773284-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e1c067f4-3646-4f44-b901-d21a92ffa600",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7258c3ef-5813-40da-95cd-2f413f82da0b",
"EffectiveDate": "2026-11-02T10:22:11.5773284-08:00",
"StateType": {
"StateTypeId": "04b1d2e1-575d-4d0e-95dd-b2a0b04f0603",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e7d2460f-e7d9-4499-a7e1-14ed7e67c8e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47206332-9522-4eb5-b19f-4d04e5e3db62",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "02e379aa-dd92-43db-9939-631b5a159d93",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "faf9096b-8cfe-462f-a840-9ec865a3cbc7",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "30f8ef73-cd24-4bbe-a214-1266ab603933",
"EffectiveDate": "2026-11-02T10:22:11.5773284-08:00",
"StatusType": {
"StatusTypeId": "ad5a60b2-1973-42fb-ae4d-f09be10c6202",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e7d2460f-e7d9-4499-a7e1-14ed7e67c8e3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47206332-9522-4eb5-b19f-4d04e5e3db62",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b0d589e3-51ad-4847-a5ce-ec80455fc212",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bb4e1010-1181-4e9f-8628-cd084f0134d4",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fd9899f0-4e03-4736-9cd7-1c5439b5701c",
"EffectiveDate": "2026-11-02T10:22:11.5773284-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "e1c6bf46-5423-4cae-92cb-427bed84456f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "36647086-03a8-496d-ac98-17b51354652d",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "152830c2-0716-441d-8b8f-17fb6e463c85",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-02T10:22:11.5773284-08:00",
"MeasurementValueNeededDate": "2026-11-02T10:22:11.5773284-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f26adce3-dc5f-4aa2-ba51-d1f59fa2ed03",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "793db3ef-1bd7-4b3d-b8d1-32fc3fe05c2c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1e1f0ae7-9fa0-4197-b7e4-f4cf6dd95f49",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-02T10:22:11.5773284-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b990c784-60ae-420a-b427-e54cd54e3ba9",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-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": "1a5ceb51-ccbb-4da9-af70-2f04cb515083",
"Asset": {
"AssetId": "88722f97-8b6e-4838-9de4-5d735f815ee2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e73c16cb-f1e2-4426-b076-8b9277d24797",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0bdcfe8b-2563-45e4-9ada-adbee1370d64",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d366e4a8-f7a7-4d42-9906-677052a76a7c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-02T10:22:11.5773284-08:00",
"MeasurementValueNeededDate": "2026-11-02T10:22:11.5773284-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "674f27c6-3fab-48ae-b0c3-680cdd3af3d8",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b3c0c8e8-4911-48e8-a369-53f73338c86c",
"EffectiveDate": "2026-11-02T10:22:11.5773284-08:00",
"StateType": {
"StateTypeId": "0e94e1b4-60cd-4311-98c3-7ac48f3af8b7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e73c16cb-f1e2-4426-b076-8b9277d24797",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0bdcfe8b-2563-45e4-9ada-adbee1370d64",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "03d17426-e61a-4321-b0be-057d5ea5323f",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b299706f-d5f0-4a12-a23c-5c8cd5594efa",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "41c133d2-4801-45fd-92ce-9d4f7502ad82",
"EffectiveDate": "2026-11-02T10:22:11.5773284-08:00",
"StatusType": {
"StatusTypeId": "e032a5ee-f8a5-490d-bd6f-ed2e25b74e59",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e73c16cb-f1e2-4426-b076-8b9277d24797",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0bdcfe8b-2563-45e4-9ada-adbee1370d64",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7bfe641b-b845-4f1c-af4d-6f9057c4f2a0",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "03cb546c-c802-442d-b61d-01029bf3d734",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "dee0458b-9e01-4d39-af23-59424ea66105",
"EffectiveDate": "2026-11-02T10:22:11.5773284-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "8922a2e5-89f0-4d0d-a0d8-b4ab27d77a82",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "80da3c1a-d877-4a80-b9d7-93d05c3fda1d",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e31387e9-cd8f-42a0-8c5c-75a5d5d987ae",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-02T10:22:11.5773284-08:00",
"MeasurementValueNeededDate": "2026-11-02T10:22:11.5773284-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0fc03314-ad1b-42f2-b6f7-a5c703487bf4",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "83ceaa21-3c8e-42f3-8d11-17073642bb90",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f7042a8a-7671-40b2-aeaa-871d1e6d6647",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-02T10:22:11.5773284-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7226db0d-824a-4444-8370-8cbc54c80b65",
"CreateDate": "2026-11-02T10:22:11.5773284-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-02T10:22:11.5773284-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}