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": "ea984dc0-3553-488f-a31d-0569e4ddbb4c",
"Asset": {
"AssetId": "51858c78-7106-406c-aa6d-fd053ac01780",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4b34c005-acff-4cea-9182-e341af34416b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8d476f0a-492c-45e4-94a4-ee5eed060cb3",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ef8bd513-9650-4f33-9b50-dc174b415597",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-14T01:54:44.2219838-07:00",
"MeasurementValueNeededDate": "2026-09-14T01:54:44.2219838-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "78243f61-e2cb-4fac-87cc-90585452f13d",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5639cba9-7b72-4263-86c3-03eea1aba5a5",
"EffectiveDate": "2026-09-14T01:54:44.2219838-07:00",
"StateType": {
"StateTypeId": "5c833241-9a4d-4301-a43f-3c3b3b63fdb7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4b34c005-acff-4cea-9182-e341af34416b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8d476f0a-492c-45e4-94a4-ee5eed060cb3",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "dee9e521-b977-4069-8130-481f64e7a0fa",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1a48bbe7-2912-49c1-b1db-640cea8214ec",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f70ec3c5-ae9b-46c3-9323-dcb198aa4531",
"EffectiveDate": "2026-09-14T01:54:44.2219838-07:00",
"StatusType": {
"StatusTypeId": "211db295-851e-4d3d-9d4a-55b39c3a4945",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4b34c005-acff-4cea-9182-e341af34416b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8d476f0a-492c-45e4-94a4-ee5eed060cb3",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6470111d-4c22-4f79-a698-771f82480b62",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4c749cd8-9662-47d4-bf24-5bd80d3dc0c4",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b1a9a32e-391d-4515-94ec-128bb2122026",
"EffectiveDate": "2026-09-14T01:54:44.2219838-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "74901a3b-bae1-4427-b21e-06feb10cbde5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c10cc197-8be3-4709-b320-bc1525a9f5a7",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2973dd37-8989-4b67-960c-0836beed2101",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-14T01:54:44.2219838-07:00",
"MeasurementValueNeededDate": "2026-09-14T01:54:44.2219838-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "72ef0800-93cf-4c0b-86d0-1095dbb1a17b",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "76fa373a-a55e-4d64-9001-68bc664befd2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3271c532-b950-48ec-9fc4-7d10c915eea0",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-14T01:54:44.2219838-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "352b7ac3-302b-4089-919b-d54461c0b4ae",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-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": "43e97ac7-eea4-43e1-9ead-a655bd72e2a1",
"Asset": {
"AssetId": "682652a4-a331-4349-a93a-063deb4300ae",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b55e3429-b7bf-4e59-8745-8384ecd82762",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "17d61171-40d6-4769-8d5b-a8c9cb9d7d88",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2409fea3-fe1e-495f-a8f7-5d002bdd947d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-14T01:54:44.2219838-07:00",
"MeasurementValueNeededDate": "2026-09-14T01:54:44.2219838-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "62f529da-842b-4f57-882e-50df361acfb5",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1c9d7fb8-0ea1-4388-b6f3-ff4004c59139",
"EffectiveDate": "2026-09-14T01:54:44.2219838-07:00",
"StateType": {
"StateTypeId": "bc7ad716-caa5-4be6-a8bc-328766a2be7c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b55e3429-b7bf-4e59-8745-8384ecd82762",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "17d61171-40d6-4769-8d5b-a8c9cb9d7d88",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f5e2de17-005f-4dbd-bba6-6709bbb4f06e",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f9111662-db4d-4279-8510-60961ac7f52d",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cec33f59-3e3c-4584-845b-fe9837591481",
"EffectiveDate": "2026-09-14T01:54:44.2219838-07:00",
"StatusType": {
"StatusTypeId": "0af35003-6264-448f-a6bf-4354a8f3a6c3",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b55e3429-b7bf-4e59-8745-8384ecd82762",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "17d61171-40d6-4769-8d5b-a8c9cb9d7d88",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "104bb580-e44e-42df-b518-a68eb0c4f5f3",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "886efbd5-31c2-44a1-a22a-9f846598455e",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6d2e8da3-b47f-4b82-87bc-c14b852b1ad3",
"EffectiveDate": "2026-09-14T01:54:44.2219838-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "def36be4-5263-47a9-9f7d-31fb1673d0bc",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3bcaa80a-42f0-496c-ae3f-03cbd89cc085",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e116a62b-a75c-4350-bd28-b9d56a8962ae",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-14T01:54:44.2219838-07:00",
"MeasurementValueNeededDate": "2026-09-14T01:54:44.2219838-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d2eba087-254d-47cc-9a80-36821af5885a",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "64232550-0edc-4eb8-8dab-9120a04abab6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d9d3773e-63fe-4364-9401-62b0ce51458b",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-14T01:54:44.2219838-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "33054e04-6a6a-4bd2-9851-1f7682e6cf46",
"CreateDate": "2026-09-14T01:54:44.2219838-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-14T01:54:44.2219838-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}