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": "9c0eb798-7949-43ee-964b-3f6b6d46bd86",
"Asset": {
"AssetId": "0bf6d90b-2cbd-49ce-8bbd-b8e707b588b8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3fb809c9-e108-4b05-b3a0-b4b74f67f178",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "04053e6d-6b4a-4171-b954-6ddd8b46d1a2",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9df7a436-045d-40e1-95a8-6c44def63005",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-09T10:48:15.8432672-08:00",
"MeasurementValueNeededDate": "2026-11-09T10:48:15.8432672-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "593f2da7-c091-4956-8821-46a4de10f665",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2abb476a-ba95-41bc-89a8-a51e76d0496b",
"EffectiveDate": "2026-11-09T10:48:15.8432672-08:00",
"StateType": {
"StateTypeId": "9023cc40-6d90-45fa-9270-498174b539bd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3fb809c9-e108-4b05-b3a0-b4b74f67f178",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "04053e6d-6b4a-4171-b954-6ddd8b46d1a2",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7fbbd10e-1191-4821-a87c-00a072250118",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "13a6ed8b-1c3d-4705-8c2f-0119a3809aed",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7a7ffba8-2eac-48af-8701-60f38ff4c680",
"EffectiveDate": "2026-11-09T10:48:15.8432672-08:00",
"StatusType": {
"StatusTypeId": "9472c0fd-fa76-49ee-b38b-004ecbbaf26a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3fb809c9-e108-4b05-b3a0-b4b74f67f178",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "04053e6d-6b4a-4171-b954-6ddd8b46d1a2",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9be057d8-9744-4e2f-8346-a7d814612bfb",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d477d048-acd3-4fcd-8f44-c2f306187f89",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8e89601d-3ec0-4fc3-ba8a-ce8daca01b46",
"EffectiveDate": "2026-11-09T10:48:15.8432672-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "5f47d93b-3417-4acf-9041-8d0ec913b3e9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8aa1afa5-a8e1-4558-a9fb-f44ac0d8fcae",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "36ac156a-a7a5-411c-bd8e-b39e1143d64e",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-09T10:48:15.8432672-08:00",
"MeasurementValueNeededDate": "2026-11-09T10:48:15.8432672-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0dd1b75f-d169-4e5e-8a78-46452f01cd45",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c38f772c-4278-4cee-a604-54a8e6310089",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fbb3614e-177b-4337-aa86-2c6e00bcd2c1",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-09T10:48:15.8432672-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d93d4c0a-3014-43bf-ad84-5258cfe461f6",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-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": "2d10dd26-0412-4492-af30-04419a87f826",
"Asset": {
"AssetId": "05ac158f-d3be-41ba-982e-31ce9bfb7b99",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d25b4f07-d721-4a60-b59b-26b032b5bc0f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a40567ff-5c29-4178-bf6f-061680531e18",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ff339c4e-7830-4bbe-910d-f04b387d7f3c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-09T10:48:15.8432672-08:00",
"MeasurementValueNeededDate": "2026-11-09T10:48:15.8432672-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3869109f-7b0a-4dd6-b2dd-37245f05cb36",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ba6b395c-954e-4568-9ae6-b452fd757e00",
"EffectiveDate": "2026-11-09T10:48:15.8432672-08:00",
"StateType": {
"StateTypeId": "c18165bb-d4b7-4f4f-8827-c3c42aa290b1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d25b4f07-d721-4a60-b59b-26b032b5bc0f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a40567ff-5c29-4178-bf6f-061680531e18",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4c4672de-0704-4db9-932a-f86ec078fef9",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7fe84de7-f61e-4b41-b9a9-1e6681117139",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "97d9ed47-5ac3-4eb0-bb5a-2611996be078",
"EffectiveDate": "2026-11-09T10:48:15.8432672-08:00",
"StatusType": {
"StatusTypeId": "e57935f1-2d4d-4e18-8229-48e8542e51b4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d25b4f07-d721-4a60-b59b-26b032b5bc0f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a40567ff-5c29-4178-bf6f-061680531e18",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "783586db-5f6d-422e-b162-e8d5f1c85595",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5b27b861-cbf1-40e6-892b-d8a6c060b878",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f8fe7347-7e97-4709-bfe6-f62f70626a48",
"EffectiveDate": "2026-11-09T10:48:15.8432672-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "cde7d768-2b9b-4e0c-9b68-f0b020b98cb0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "72d4ba8a-16d8-4dea-9eb2-0249e7dca4f8",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c61eedca-1710-4ead-b62b-1e2e8c56dce5",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-09T10:48:15.8432672-08:00",
"MeasurementValueNeededDate": "2026-11-09T10:48:15.8432672-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "54be4858-fe0d-4e5b-b7b0-9e1aa5da55a5",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "2e005115-277e-4db5-aa2e-ce6d81965588",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6fccfaf3-5f89-43b1-a910-c26dd90635f7",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-09T10:48:15.8432672-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "006ac045-7328-4000-91c5-d350e13c825b",
"CreateDate": "2026-11-09T10:48:15.8432672-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-09T10:48:15.8432672-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}