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": "01e999ae-32c1-42cc-bf63-add959e9958c",
"Asset": {
"AssetId": "b853a293-7912-4e98-9015-cb1f953f7690",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c143c8d4-47f8-4a7c-b73c-871735928950",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b01b4326-746d-419b-820a-1632999e5572",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "1f772c72-b07c-4240-aef0-fa867bba7841",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-26T00:00:35.2129832-08:00",
"MeasurementValueNeededDate": "2026-01-26T00:00:35.2129832-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "005855de-4c25-4265-a9e1-7d6f658ad419",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "79723178-f82e-44e5-9442-0ac87098344a",
"EffectiveDate": "2026-01-26T00:00:35.2129832-08:00",
"StateType": {
"StateTypeId": "9ceac442-94cd-417a-9a82-9a4ab6c1a584",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c143c8d4-47f8-4a7c-b73c-871735928950",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b01b4326-746d-419b-820a-1632999e5572",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "1358a6f3-da3e-4aff-ac37-f414e22a9bde",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0f1a8f97-3a66-4820-acf3-813a4ed27902",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1cb60893-e3de-4c56-880f-de965da248dd",
"EffectiveDate": "2026-01-26T00:00:35.2129832-08:00",
"StatusType": {
"StatusTypeId": "65f8918b-f79c-40d5-b75c-53424ec52145",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c143c8d4-47f8-4a7c-b73c-871735928950",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b01b4326-746d-419b-820a-1632999e5572",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a2ee0aef-9578-4ae0-9c39-21ef1736cfcb",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cf94240b-97f6-498a-b6e9-d1df23242820",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5d8b5f4c-fc25-467c-be85-61450ceb587a",
"EffectiveDate": "2026-01-26T00:00:35.2129832-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "401bfe9b-9241-4e9d-84ee-d38d525aa919",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dcb8a412-35d6-4a54-b0d3-071989c4ec57",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2bee0865-da40-4b1d-9579-62c885d7ed6e",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-26T00:00:35.2129832-08:00",
"MeasurementValueNeededDate": "2026-01-26T00:00:35.2129832-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f3cccf4b-98b1-4974-8023-cb92d080fd5c",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "249c9cf1-da06-48df-a3aa-a2cc86a975f1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6dac108f-1988-4efb-aafe-e96a5b817c90",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-26T00:00:35.2129832-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "cd760fa3-6d95-4098-a55b-66988678fe9b",
"CreateDate": "2026-01-26T00:00:35.2129832-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-26T00:00:35.2129832-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": "4e112b56-6933-451a-a536-a540413d8e13",
"Asset": {
"AssetId": "475f90e4-8657-4f21-99da-49c4315d2e51",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1885d0a7-ab86-4f8d-a622-f158431acfed",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b94cd945-508f-4346-93bf-e9b8159d8b13",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0a07ef73-3743-4c41-af6b-171816cc39a7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-26T00:00:35.2286044-08:00",
"MeasurementValueNeededDate": "2026-01-26T00:00:35.2286044-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1707c65c-59cc-450d-8c48-03060809cc77",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2aaa2f9e-3ad2-4564-b32b-d0955b7bb2ce",
"EffectiveDate": "2026-01-26T00:00:35.2286044-08:00",
"StateType": {
"StateTypeId": "0d98d790-0211-44e4-9ff3-11e9c1fbdc46",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1885d0a7-ab86-4f8d-a622-f158431acfed",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b94cd945-508f-4346-93bf-e9b8159d8b13",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "22bdef26-72aa-4966-8601-ef5c2e8f98ef",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b09fb6cb-5e55-41bb-a3fa-28104121d648",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "67eb9a9a-e40c-4731-af4f-0d095da4100a",
"EffectiveDate": "2026-01-26T00:00:35.2286044-08:00",
"StatusType": {
"StatusTypeId": "f041332b-6b6f-466c-8dd2-18f8b0bba0a5",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1885d0a7-ab86-4f8d-a622-f158431acfed",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b94cd945-508f-4346-93bf-e9b8159d8b13",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e52c75f4-9eb0-4ae9-8ae8-4e1ec7045b4c",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "66375fe3-5e4c-4361-9414-025afd33bae5",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "673fb79a-175b-4a14-9fec-fb0d0722edf1",
"EffectiveDate": "2026-01-26T00:00:35.2286044-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "fd02a867-a639-417a-b2d8-60431bdba693",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "57a2e7fe-b6e2-4afc-b98e-618357905a2b",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3026ee9d-e73f-484e-8742-660898cd6f05",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-26T00:00:35.2286044-08:00",
"MeasurementValueNeededDate": "2026-01-26T00:00:35.2286044-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fcfc9961-033a-4422-b121-df8714ada309",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "049d36d3-d969-458b-9aae-a730b616d19f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "afc03ab9-fd43-4c1a-a855-5371cf17b14f",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-26T00:00:35.2286044-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b23e187f-ea9d-41cc-98fe-848188b779d7",
"CreateDate": "2026-01-26T00:00:35.2286044-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-26T00:00:35.2286044-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}