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": "c0a83b1d-81ae-4fb0-bfb6-41d4f0b23cf7",
"Asset": {
"AssetId": "d44042f3-190e-43c5-86e2-9775cadd832f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d43f5636-165b-4f7b-b661-7f2d911b2444",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0cbd040-9eee-4687-af3d-3f8dcc2bb979",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "64b78934-c911-42fe-ab30-e762db9ded62",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T22:23:27.0379194-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:23:27.0379194-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6223fda9-7ab3-42bf-8711-d567a9586c71",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "43e95da2-1cc4-4fde-9222-a4110c29fb6b",
"EffectiveDate": "2026-08-11T22:23:27.0379194-07:00",
"StateType": {
"StateTypeId": "5580b74c-3080-4a97-85c4-f399713d5f36",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d43f5636-165b-4f7b-b661-7f2d911b2444",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0cbd040-9eee-4687-af3d-3f8dcc2bb979",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3426a0ee-496d-4874-b1d3-55cae27eda9c",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "63377016-c33c-4ac8-a8a2-e0b4f4b3857f",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6cb5720f-28b5-425c-9f9d-e3f72269c238",
"EffectiveDate": "2026-08-11T22:23:27.0379194-07:00",
"StatusType": {
"StatusTypeId": "c6635a4e-0381-40b7-aaa0-16e4e09528b0",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d43f5636-165b-4f7b-b661-7f2d911b2444",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0cbd040-9eee-4687-af3d-3f8dcc2bb979",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "886e42a4-385d-457b-8047-186517ef2bba",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3cb858a0-bc85-4cc3-aab9-75d38679ef65",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "313cd0da-6f66-4cdd-97be-a7e2a83aaff5",
"EffectiveDate": "2026-08-11T22:23:27.0379194-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "7c5ab4bf-d85f-460c-b1a7-337262e1e37d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "380d06c9-c370-4a2e-9d57-1b1878b46447",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "28da009c-95a3-4eb4-b517-6d1f5b3f47c6",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-11T22:23:27.0379194-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:23:27.0379194-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2cfeddf1-1ffd-4aaa-9772-b1f7d1e4f115",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6c5a8c2c-5d57-454f-8aea-28b1dae23ac8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3ffe5442-5d6c-403b-b185-56d6619b7f8d",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-11T22:23:27.0379194-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "744bf811-5c1a-410e-85b8-5897c5b6a354",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-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": "82ecc519-d92e-4878-a8e9-15ca4067f2a9",
"Asset": {
"AssetId": "e1e4a915-70c7-4d50-834a-bae465bb2757",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "dd88ff1e-26e6-48ee-a7d1-c3bda1056c45",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34b2c93c-2dbb-4a75-8765-cc0b71b1670c",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c837ff1b-4066-44a3-80d1-1726b55f0811",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T22:23:27.0379194-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:23:27.0379194-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f2f08798-3ac7-4b2c-8a43-176c271c2355",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a0241d24-fa6c-4b71-9612-25a0ffc1bec9",
"EffectiveDate": "2026-08-11T22:23:27.0379194-07:00",
"StateType": {
"StateTypeId": "41a95c75-f0e9-4e51-8cbd-eef8d715213d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "dd88ff1e-26e6-48ee-a7d1-c3bda1056c45",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34b2c93c-2dbb-4a75-8765-cc0b71b1670c",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "1f2c5826-842a-4366-95cc-eeedb7ce4eb1",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4bbaf378-7f72-4c5f-9e25-c59e8b2aa51b",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6ff7d2ed-9136-4596-862f-be6f3c387c6c",
"EffectiveDate": "2026-08-11T22:23:27.0379194-07:00",
"StatusType": {
"StatusTypeId": "c05b28fb-778a-4c9f-b1e7-1595244c9f75",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "dd88ff1e-26e6-48ee-a7d1-c3bda1056c45",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34b2c93c-2dbb-4a75-8765-cc0b71b1670c",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6ef50fb2-442a-4eff-8397-633bb0d0173b",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "32c82da0-940f-474a-a944-8ba674283cd3",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c71e4ae0-8aee-4201-b8ab-39a90789f9c7",
"EffectiveDate": "2026-08-11T22:23:27.0379194-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3506dc0d-31d1-486e-aaa2-057a743d453a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f5124fd2-0571-48a2-b2d0-6ee382f8c8dc",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "516e8bb9-3d09-410f-9288-f2619b2dc074",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-11T22:23:27.0379194-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:23:27.0379194-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "005f2676-4bb1-4afe-8410-8ca7f265c6c6",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "8c30f502-8fd7-411d-b8df-834244a05900",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b8edfabe-9ac0-4f3b-99ca-ec75c3f633a0",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-11T22:23:27.0379194-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "23bc516e-8f61-49fb-9119-d2d9ee0e03ee",
"CreateDate": "2026-08-11T22:23:27.0379194-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:23:27.0379194-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}