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": "3875464a-001d-47bc-93cb-dc3d5636ad22",
"Asset": {
"AssetId": "74d2dfbc-8344-4f7f-8cc9-134cbe2056ba",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2aa972b5-7577-4066-af57-4847d9c52773",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5b7108de-8ea1-4e83-9b94-3eb5189fe0e9",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e9bf8ca6-0167-4b89-8657-5ccacd846dcf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T22:40:30.2690299-07:00",
"MeasurementValueNeededDate": "2026-08-09T22:40:30.2690299-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "935270e4-132d-46d3-bf3a-ddf9c73acccf",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a918b58b-c76c-4c19-81ce-7694c700c5bd",
"EffectiveDate": "2026-08-09T22:40:30.2690299-07:00",
"StateType": {
"StateTypeId": "902e9fda-4ac7-4e8d-a434-6d012a5c57f8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2aa972b5-7577-4066-af57-4847d9c52773",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5b7108de-8ea1-4e83-9b94-3eb5189fe0e9",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c97c0de8-f2a7-438c-aa0f-2335d33f3f03",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4a4b715b-adf6-4507-9c6f-91b9f89db5f8",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "37bc070c-5e76-4084-936d-9aeeb89d47b5",
"EffectiveDate": "2026-08-09T22:40:30.2690299-07:00",
"StatusType": {
"StatusTypeId": "f431e7c1-4cb0-4002-add2-b3689719dfdc",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2aa972b5-7577-4066-af57-4847d9c52773",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5b7108de-8ea1-4e83-9b94-3eb5189fe0e9",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8160258a-19fd-4456-bc46-e8b2a5085c6c",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a47885cc-d2b4-4eac-9826-014785abd5f3",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f5388aae-d589-4e6c-beaf-13f963f2d73c",
"EffectiveDate": "2026-08-09T22:40:30.2690299-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e6b6cd53-1390-4a69-82bc-5e3ae684f028",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e3a5eb84-c9d3-4fd8-bc78-86d6aa998167",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f999e557-ca34-4883-bc22-21c95b981a29",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-09T22:40:30.2690299-07:00",
"MeasurementValueNeededDate": "2026-08-09T22:40:30.2690299-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cd0a01f4-21ea-4329-9ce0-4b926d4f045e",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ea34c5f3-7477-4846-8d84-372b66cbefe9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f5612d70-a772-4e2a-8bb1-556202999fc4",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-09T22:40:30.2690299-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4addae6-9b9f-4d7f-839c-5fc116fabf7f",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-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": "aecb7e86-48b5-4cd4-819f-c85298788ee8",
"Asset": {
"AssetId": "26582470-ed99-434f-9b25-3ae599a4eb86",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0cc993a2-cc18-407d-92b8-48ecf2d1cdb2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1c50ee2-bd2b-4b79-aa10-d7ac7539e987",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d6f71562-3645-4c0b-b3f6-19bcf06b0041",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T22:40:30.2690299-07:00",
"MeasurementValueNeededDate": "2026-08-09T22:40:30.2690299-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d6a1f072-dc04-4b19-897b-2bef2a00ea4c",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "abfc1943-c729-412d-8797-7020a85e9d8e",
"EffectiveDate": "2026-08-09T22:40:30.2690299-07:00",
"StateType": {
"StateTypeId": "cf522210-42c6-4773-a5ae-0bf226d05e2e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0cc993a2-cc18-407d-92b8-48ecf2d1cdb2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1c50ee2-bd2b-4b79-aa10-d7ac7539e987",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d518c986-18c9-4f57-aadf-11c0d2b5287c",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a0d23e45-41e6-41fd-87a8-40aa2d70b24c",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "90b15247-124d-48b9-923d-703d482c8401",
"EffectiveDate": "2026-08-09T22:40:30.2690299-07:00",
"StatusType": {
"StatusTypeId": "7613c507-fcbf-4f7a-b400-f9cf48e24bb9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0cc993a2-cc18-407d-92b8-48ecf2d1cdb2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1c50ee2-bd2b-4b79-aa10-d7ac7539e987",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5ed18d2c-2aa7-4c0a-b8e6-0ce1e4bd3ff8",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ec43df80-4440-43fb-9a72-ec7b2ee66836",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8289e048-2b37-4f11-a1b5-cfe14578b752",
"EffectiveDate": "2026-08-09T22:40:30.2690299-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c800f2b0-fa7c-4483-bb6d-4ac2f9ccf133",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ff99d8ad-54dd-4267-adb4-62a55e9578b9",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2d282d04-fae1-46cc-a5cd-5c6baf7d3115",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-09T22:40:30.2690299-07:00",
"MeasurementValueNeededDate": "2026-08-09T22:40:30.2690299-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3ad467f9-dfa2-4f75-b1d8-20d42689bf05",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "1290222c-066d-4c86-acbc-7fe3d8150490",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4ac7caf9-8324-4fe9-aaaa-154cd88a0ce7",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-09T22:40:30.2690299-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "84e63ed5-9839-4a24-8156-e01b53fc504f",
"CreateDate": "2026-08-09T22:40:30.2690299-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T22:40:30.2690299-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}