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": "2c2fc636-4979-43c8-8202-0ea64491de6d",
"Asset": {
"AssetId": "cbcecabb-dc58-47bb-b098-ae50deb7a095",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "145c52ea-9116-4f38-b4fa-a0aff6186a5f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "336235cb-465c-4862-8b12-eeaaaddf70d0",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c9a9e15d-3035-42c0-82ab-5beefad40ca0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-19T10:13:10.1945619-07:00",
"MeasurementValueNeededDate": "2026-03-19T10:13:10.1945619-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4aae01f3-6f8e-457c-b082-434947a41eac",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d0b8cd17-7120-4cca-8257-e0e77263225d",
"EffectiveDate": "2026-03-19T10:13:10.1945619-07:00",
"StateType": {
"StateTypeId": "2d17b859-c681-40a7-8683-8b75e475dc73",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "145c52ea-9116-4f38-b4fa-a0aff6186a5f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "336235cb-465c-4862-8b12-eeaaaddf70d0",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "59192bfe-7475-4e5e-9e8f-89528625fe5c",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7d1bc4f9-cbc3-4b11-8c3a-3f1c08eeb513",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "dee5b721-291c-47ff-8704-5f504c459a54",
"EffectiveDate": "2026-03-19T10:13:10.1945619-07:00",
"StatusType": {
"StatusTypeId": "535ecad3-eaf2-4710-a10e-59794ac58a90",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "145c52ea-9116-4f38-b4fa-a0aff6186a5f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "336235cb-465c-4862-8b12-eeaaaddf70d0",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8ca29b1f-a41e-428d-a926-e9aaa2c8fee8",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "591b6b0b-f469-4e1e-8f41-21cf0be7d0a0",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "67fccce9-276f-44ba-99f8-2996908351e1",
"EffectiveDate": "2026-03-19T10:13:10.1945619-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "50b28687-4f58-4dec-ab6e-97339b151a0b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "27aec1e0-e211-478d-84cd-ccaa5fc7cb97",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aadd11ce-d9c5-4c76-8979-8ce7a65e3eaf",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-19T10:13:10.1945619-07:00",
"MeasurementValueNeededDate": "2026-03-19T10:13:10.1945619-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "354a3b29-6fa2-4207-ae9b-4ccafefa58dc",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "77dbfcaf-b3de-4653-a3a8-d4ca20fd58a3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "98d4663f-22d4-4c6e-88bf-97eb8e1b90e2",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-19T10:13:10.1945619-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b36f9026-15fd-4462-839c-9d66cc9cdc75",
"CreateDate": "2026-03-19T10:13:10.1945619-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-19T10:13:10.1945619-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": "abb91796-0cef-4ea4-91a2-79b4e423dded",
"Asset": {
"AssetId": "97ad01ac-3da8-4824-bb2e-016c8bb507ed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e59139a2-3272-461b-a858-638a407eba03",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7b72c1c0-677f-41f0-8fb6-d4d903511ce7",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "799550f3-d731-4990-822f-5b4000608e80",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-19T10:13:10.2101297-07:00",
"MeasurementValueNeededDate": "2026-03-19T10:13:10.2101297-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ab61a8f5-ee76-474a-954f-3c53f504be12",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8f290ef4-a4c1-4d35-9871-a4912703c254",
"EffectiveDate": "2026-03-19T10:13:10.2101297-07:00",
"StateType": {
"StateTypeId": "a6377ee3-5111-4c26-8128-aaad5eaa31ec",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e59139a2-3272-461b-a858-638a407eba03",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7b72c1c0-677f-41f0-8fb6-d4d903511ce7",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f64e6a5d-01b1-4f7e-a849-875caad78be2",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5db1cdbd-5812-4fcd-894d-985d8f25c32d",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fbd8cd5d-5d4e-48b6-be32-aa2cb25160f9",
"EffectiveDate": "2026-03-19T10:13:10.2101297-07:00",
"StatusType": {
"StatusTypeId": "07165ad7-3231-44c0-922c-71310da1db8e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e59139a2-3272-461b-a858-638a407eba03",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7b72c1c0-677f-41f0-8fb6-d4d903511ce7",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d3f289be-95d0-400f-b088-fa62834669df",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "52b1745f-3993-4731-9877-734065d1322c",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0c65d07e-e785-4208-a4d3-bedf5dff1e10",
"EffectiveDate": "2026-03-19T10:13:10.2101297-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "61287a96-e5ca-4c20-9bcb-2996099e9e7e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "70c03ec3-c126-47ca-b290-ad0a98e6f6c1",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "92179f9b-10b7-4062-9999-2879debd57f4",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-19T10:13:10.2101297-07:00",
"MeasurementValueNeededDate": "2026-03-19T10:13:10.2101297-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6b4636b1-c630-40b5-94f1-d08b35b6eeef",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4f82166b-4b02-4b5b-90aa-deebcb820ef5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "529af665-2d63-4ee4-8cf9-c1695a33a5f1",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-19T10:13:10.2101297-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ddc8d951-06e9-4d35-8349-e80191c4ce50",
"CreateDate": "2026-03-19T10:13:10.2101297-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-19T10:13:10.2101297-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}