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": "e8297f02-b751-4a80-a322-1618d56c8539",
"Asset": {
"AssetId": "7b612cb5-6516-4955-87b1-d4fe14b8a867",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ff4e0731-b59a-4ce8-a623-88396d04bc24",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f5bf0985-4c6b-4c01-9e44-52121b7da912",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b585fb94-765d-4073-b231-178b310fc3c9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-01-30T12:31:29.6737156-08:00",
"MeasurementValueNeededDate": "2025-01-30T12:31:29.6737156-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7b3b844c-bcac-4208-8c6c-0fa93df86fc1",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "fb5bff85-9fd8-43ab-a5ce-0672f00d67cf",
"EffectiveDate": "2025-01-30T12:31:29.6737156-08:00",
"StateType": {
"StateTypeId": "5b6f52a4-a0a7-4ab1-a014-55e83d4aa40b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ff4e0731-b59a-4ce8-a623-88396d04bc24",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f5bf0985-4c6b-4c01-9e44-52121b7da912",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f95276b6-fa96-4196-92eb-b7dd14f78de7",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "eb314003-47cf-4cdd-9c1b-37d2b40b1c39",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "31da0202-56e6-440f-abc8-e4efb60dc94e",
"EffectiveDate": "2025-01-30T12:31:29.6737156-08:00",
"StatusType": {
"StatusTypeId": "73621400-2182-412f-a0cc-a771e038f19f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ff4e0731-b59a-4ce8-a623-88396d04bc24",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f5bf0985-4c6b-4c01-9e44-52121b7da912",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a55af8d0-ba6c-4e73-b253-d29cafa7b16d",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "54d3cead-3c98-4792-9ce3-2750d7e40f7c",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "67447b69-f83e-4c03-98dc-294165fad9c3",
"EffectiveDate": "2025-01-30T12:31:29.6737156-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d25b78ad-5e96-4f45-9e21-2ada13d38ea4",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b275862e-293b-4390-84f4-5d0fcf885e4b",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "633f365f-7ec9-4a8d-a27c-4d04de04283d",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-01-30T12:31:29.6737156-08:00",
"MeasurementValueNeededDate": "2025-01-30T12:31:29.6737156-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "843601f8-20b3-4ec4-baee-8b87d8f7442e",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "65d75091-3b74-488c-8dc8-0129c06578db",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d12c6479-0aa3-4aff-8feb-3f86bda0fdc7",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-01-30T12:31:29.6737156-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "60cae3ac-6241-428a-a8f4-5ce799ffab47",
"CreateDate": "2025-01-30T12:31:29.6737156-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T12:31:29.6737156-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": "9fa43e3e-b194-4787-b3a9-26e970c1a3c8",
"Asset": {
"AssetId": "ab7a3855-6e88-4194-8867-7c39be1bee0f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "df3e1ff9-1794-4206-8ed8-d6ec933fedce",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1aa1d372-e7c3-4bff-9421-bddf7c9873ea",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "cf5945ff-2547-428f-9f03-c6dfba7dc2c1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-01-30T12:31:29.6893347-08:00",
"MeasurementValueNeededDate": "2025-01-30T12:31:29.6893347-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "53fbf14f-fe3d-4c4b-90e0-30e87bb003a1",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f6f0fac5-9493-4af2-88cc-c76d6950a321",
"EffectiveDate": "2025-01-30T12:31:29.6893347-08:00",
"StateType": {
"StateTypeId": "e66e1ae4-d8c5-42e2-aea2-f6ecb48999f8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "df3e1ff9-1794-4206-8ed8-d6ec933fedce",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1aa1d372-e7c3-4bff-9421-bddf7c9873ea",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "525dfa23-afff-49c2-bd7c-3c87a37c9db6",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3f60be76-3dee-4f77-8ff6-da113bbd255f",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0f126dbd-eedd-47fc-9460-5839483283d8",
"EffectiveDate": "2025-01-30T12:31:29.6893347-08:00",
"StatusType": {
"StatusTypeId": "c231cedd-4fd9-4c4b-9f27-65cfea58f7f2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "df3e1ff9-1794-4206-8ed8-d6ec933fedce",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1aa1d372-e7c3-4bff-9421-bddf7c9873ea",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5a934c5e-fe45-4a17-9e71-3512246ef3f5",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bc39fc88-94cc-4fa8-bae7-804d91e93bbe",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e5de341c-d829-48d4-817a-1856d496416c",
"EffectiveDate": "2025-01-30T12:31:29.6893347-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "a4061dee-5990-41ec-a2d9-3b05b781d399",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "49328342-0fd7-41ac-baf8-eb86d167a9d3",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5368aa4d-c86d-4acf-af40-3b14eeb168a8",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-01-30T12:31:29.6893347-08:00",
"MeasurementValueNeededDate": "2025-01-30T12:31:29.6893347-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1115c096-2ccc-4383-b30b-f0fe17e534f7",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "83fc60e5-ca45-42a4-ac08-bb32dcfa8d4f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4d3ada8b-1928-49ab-a3b9-e40a5a8008e4",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-01-30T12:31:29.6893347-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5a3cb63c-2a4b-4046-97bc-efbb22b27c6b",
"CreateDate": "2025-01-30T12:31:29.6893347-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T12:31:29.6893347-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}