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": "d83897d5-4bf7-462c-9f8e-9fbd274f337f",
"Asset": {
"AssetId": "70d9c119-813b-48b1-80db-87b6d3833915",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6abcdf7a-e171-429e-a427-084f3feed997",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "caab7e97-6158-4087-b912-f901eea16549",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "20d32769-630c-461a-b1e6-1bfb605685f3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-17T04:27:40.0185123-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:40.0185123-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "80c4e95a-7239-4a95-919a-a074d5114426",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "74898259-f41e-4e49-b3d2-b4f61b16534b",
"EffectiveDate": "2025-12-17T04:27:40.0185123-08:00",
"StateType": {
"StateTypeId": "9f64806f-c14d-4ab7-81c1-ab6cd2b72454",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6abcdf7a-e171-429e-a427-084f3feed997",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "caab7e97-6158-4087-b912-f901eea16549",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "35c934b1-b92a-4b7c-875b-bdae0b6d1a50",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4cd1e37e-7baf-43eb-943e-d7b6533f0dfc",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e82a6468-34ee-42e3-a621-f891a7584195",
"EffectiveDate": "2025-12-17T04:27:40.0185123-08:00",
"StatusType": {
"StatusTypeId": "9b5e7a06-a48f-4164-8c4d-210a890cb9e6",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6abcdf7a-e171-429e-a427-084f3feed997",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "caab7e97-6158-4087-b912-f901eea16549",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e22e8cb0-5a28-47b5-8f9a-b86ca6870032",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "44b94b42-9e3d-485b-80c7-b79e0d130a55",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "629d00b9-26ed-40f1-9492-1a4677d17b4b",
"EffectiveDate": "2025-12-17T04:27:40.0185123-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "3ab13dcf-5998-47f1-b402-caebca5529fb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "69db6ce0-1d8c-4f06-9436-232ead7cdc38",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "93602720-da97-4c47-97a7-98c6919b3bc2",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-17T04:27:40.0185123-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:40.0185123-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e109eef3-7059-43e7-a6ed-95571a7017cd",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3a1a3185-27c6-44c5-ac02-af4e152b657b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "669d92ca-6a49-4c07-aea4-ee0a1c74e43d",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-17T04:27:40.0185123-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "14e53d82-09f8-42fa-b7c8-e5119ba0cc0c",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-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": "e831b124-37d4-4890-adc5-7608bb99482e",
"Asset": {
"AssetId": "3905bf24-b612-4cbe-b765-77b08a85dafa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fe9d73dd-0a8f-499d-ac11-459171b89d26",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b8d654fd-846f-4448-bb35-a9822dcdd936",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f8b00fc4-6e04-480e-91ab-99da2db16af2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-17T04:27:40.0185123-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:40.0185123-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8930fc6a-0acd-4d63-8c46-a204b38d9b80",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "98979911-96a8-47f5-91a5-a7f93e2b4dd1",
"EffectiveDate": "2025-12-17T04:27:40.0185123-08:00",
"StateType": {
"StateTypeId": "c1d854ba-8487-4060-9214-4cab9d506a07",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "fe9d73dd-0a8f-499d-ac11-459171b89d26",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b8d654fd-846f-4448-bb35-a9822dcdd936",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6cac1c9e-9859-464a-978e-ee3399684d2d",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e56d59b4-2d34-4f12-b8a0-7483ccb6ce05",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f70211b5-ed7d-4bfb-a78c-3b0a60885797",
"EffectiveDate": "2025-12-17T04:27:40.0185123-08:00",
"StatusType": {
"StatusTypeId": "6b10f84e-5dc4-4f08-b018-2d8a2487578d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "fe9d73dd-0a8f-499d-ac11-459171b89d26",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b8d654fd-846f-4448-bb35-a9822dcdd936",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6b6536fb-c2f1-45e7-83e1-43351dba9c87",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c3cf4cf0-10ae-4513-b0b3-917c2b7cb8e9",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c394a016-69bf-412f-bd1d-6fe51737d69b",
"EffectiveDate": "2025-12-17T04:27:40.0185123-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d93d43f0-7168-42b2-a9c6-80c3f52c3d78",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f18f0499-a530-4e6e-a79d-834660de35a7",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e0a1cc63-53f8-49df-bbcf-0be79544746e",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-17T04:27:40.0185123-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:40.0185123-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bba2c8db-5787-4231-8e22-ac9e117762a8",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "87876176-b528-46bf-a4af-b476ad37e78c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fc225982-fb7b-4569-a63a-8614f640908f",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-17T04:27:40.0185123-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a785a1b9-cb7a-4276-9f3e-7cc2a00f3bae",
"CreateDate": "2025-12-17T04:27:40.0185123-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:40.0185123-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}