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": "765010c6-31b3-40bb-b396-364771dd0273",
"Asset": {
"AssetId": "d993a255-c0f3-4cae-9199-76b07cf93f02",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c567326c-128c-4677-bb99-5021a115e606",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "65010bed-8814-4274-8fca-f862b5f8fc5d",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "127791f5-99dc-41e6-b4ff-2a23d424cf08",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-09T00:18:56.8603188-07:00",
"MeasurementValueNeededDate": "2025-05-09T00:18:56.8603188-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c21610cc-db9a-4647-9b88-8fae48715642",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b4d55641-fa78-41eb-b13b-101917a89569",
"EffectiveDate": "2025-05-09T00:18:56.8603188-07:00",
"StateType": {
"StateTypeId": "a644040d-3fb9-493a-9ada-ff75496308e5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c567326c-128c-4677-bb99-5021a115e606",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "65010bed-8814-4274-8fca-f862b5f8fc5d",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0aedce74-4e1d-443b-8447-d52f10586345",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "05e664b3-e9d6-435a-8674-15d4549a152e",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4d4fb328-39fa-417d-911b-bfb9527dfc9c",
"EffectiveDate": "2025-05-09T00:18:56.8603188-07:00",
"StatusType": {
"StatusTypeId": "3b48abd3-5871-41b5-8077-f613b27f31d3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c567326c-128c-4677-bb99-5021a115e606",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "65010bed-8814-4274-8fca-f862b5f8fc5d",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f172f731-8d11-463a-9426-cac94c342352",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e3e8b1a3-caf8-410d-9c10-d5afd2b8f2a8",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ad097b3b-84b1-4611-9b64-da5285a7b507",
"EffectiveDate": "2025-05-09T00:18:56.8603188-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8e4005af-db38-4e22-9203-e9833921e3a4",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "03bc586b-3977-4bf7-9c96-26f583092a5f",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7fd5131d-2c75-4f13-9835-8ca06eee615e",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-05-09T00:18:56.8603188-07:00",
"MeasurementValueNeededDate": "2025-05-09T00:18:56.8603188-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "99ad9db1-60c8-470f-bcb0-4efd12976596",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f1f5a647-9b7d-4737-b6c1-025f79db7270",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b0de973b-6d8f-4df8-b2d2-3bf748185601",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-09T00:18:56.8603188-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f6686420-4170-4600-ac23-8cd59db3dfce",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-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": "f2efc58d-bb16-437b-a05a-995d8886a041",
"Asset": {
"AssetId": "69ab4a08-8ae2-495f-bf29-e1d1c643f137",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "92c3bf10-2459-4114-beb3-70185fefdedf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a356ac5f-6304-49fe-becb-fc2ea90996b1",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ac6064a8-4d74-4a78-b393-a723dec76eec",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-09T00:18:56.8603188-07:00",
"MeasurementValueNeededDate": "2025-05-09T00:18:56.8603188-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7c9c26b4-8264-4f61-b500-825a030e2c3a",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e959f5ed-b707-4b79-a14b-21d75e1628a7",
"EffectiveDate": "2025-05-09T00:18:56.8603188-07:00",
"StateType": {
"StateTypeId": "2d2f0a1b-7ccb-423f-afae-1f08dec126ae",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "92c3bf10-2459-4114-beb3-70185fefdedf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a356ac5f-6304-49fe-becb-fc2ea90996b1",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a35ed42c-0629-4e1f-9614-fdaea3f0a0f7",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "39340c2d-d08b-4e99-a48d-1791acc26728",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3bc00b13-926b-4fe9-a391-270e46ce29c1",
"EffectiveDate": "2025-05-09T00:18:56.8603188-07:00",
"StatusType": {
"StatusTypeId": "88144e95-6f4f-438b-aac7-3b1afb6f6e86",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "92c3bf10-2459-4114-beb3-70185fefdedf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a356ac5f-6304-49fe-becb-fc2ea90996b1",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8b834697-85a8-41c5-b91d-b6a46eaaca34",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "29d4289d-22ce-4a7a-abd6-fb5e5ba61dcc",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "324bf9c1-c402-42d5-b881-ac917a4389e9",
"EffectiveDate": "2025-05-09T00:18:56.8603188-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0a830584-107f-41a8-acc7-6e4541663827",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8a418f30-a017-4066-ab9f-c0c3b563a11f",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d568eca8-3cb7-4a60-b596-fdc6333b44c3",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-05-09T00:18:56.8603188-07:00",
"MeasurementValueNeededDate": "2025-05-09T00:18:56.8603188-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bdc8e7ff-9bfe-4a4a-b906-b6f6e2cc56bd",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "810febf4-f796-47ee-8e37-489b32ff89e8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1b95f5d7-00b0-4072-8461-2551a2be996b",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-09T00:18:56.8603188-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5fbbb6a2-3516-4429-a349-c9f1793d9b71",
"CreateDate": "2025-05-09T00:18:56.8603188-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-09T00:18:56.8603188-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}