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": "5504ca30-0d06-45d4-a61f-b5bf3d12e006",
"Asset": {
"AssetId": "d08f4539-87d1-4f4a-b708-6e85c00c3567",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fd3c5bb8-df27-4e3a-8834-773c0c698f2a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "873ab58d-fb78-4507-bae1-2af2af756c52",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "17483d72-59e7-49b8-9a78-a45d519ede39",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-17T11:26:35.2688284-07:00",
"MeasurementValueNeededDate": "2026-05-17T11:26:35.2688284-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f009956a-1153-4745-8ec1-f09ef7dd65b2",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "bfb0b705-3d2a-44f9-885a-681b7c8f56e6",
"EffectiveDate": "2026-05-17T11:26:35.2688284-07:00",
"StateType": {
"StateTypeId": "efe50145-0122-4436-a56f-cfc61be8822b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "fd3c5bb8-df27-4e3a-8834-773c0c698f2a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "873ab58d-fb78-4507-bae1-2af2af756c52",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "108a1d23-1723-4df7-8bf4-ce2e7e133bb7",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d9984c4b-ecd2-47f7-b63a-f623ab0f54c7",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d44b9237-e322-488e-9bce-40661fed55a6",
"EffectiveDate": "2026-05-17T11:26:35.2688284-07:00",
"StatusType": {
"StatusTypeId": "2d2765c3-507b-4062-b965-6a9ce70ded2c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "fd3c5bb8-df27-4e3a-8834-773c0c698f2a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "873ab58d-fb78-4507-bae1-2af2af756c52",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b54bdd79-224f-4597-b60d-bc54924a83d5",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4e4e52b3-706e-42d3-92df-5de3965f50fa",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a9a7d5eb-dd6e-44b3-9e10-a19627fe40b6",
"EffectiveDate": "2026-05-17T11:26:35.2688284-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3951053c-7de6-453c-8e3f-e527444f686b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "13a18970-8698-444d-8197-75733dbd8bda",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "878bf9a1-d0e1-4bb1-ae4f-0764af172c75",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-17T11:26:35.2688284-07:00",
"MeasurementValueNeededDate": "2026-05-17T11:26:35.2688284-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9ec31475-bb9c-4f47-9f54-5171b3b0b722",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "2d2ab965-0f9d-4dad-836d-d0729fee866a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ece4ff5c-c2db-43df-90ce-c005f82be505",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-17T11:26:35.2688284-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "95c4ce65-8f1b-40b7-9c2e-0ae583430c9d",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-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": "fe17dd9c-84f4-4ec3-8b6a-286ab983f305",
"Asset": {
"AssetId": "cb94bb9f-df8d-4766-b626-d9a1e1f4465b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "05465f16-1a67-45f9-8f7b-a0f54ec04ed9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "91de644e-2861-49fc-97f5-f146756e95db",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "21139a40-5348-4390-a03d-e0d12deea8d7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-17T11:26:35.2688284-07:00",
"MeasurementValueNeededDate": "2026-05-17T11:26:35.2688284-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8ab76d25-3f41-4f1b-82f9-c1c5ec651c41",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "be1e145a-c18a-41e1-b80c-fa8c9e2be5a9",
"EffectiveDate": "2026-05-17T11:26:35.2688284-07:00",
"StateType": {
"StateTypeId": "bf31100e-2655-4172-86cb-a6b36ee09adf",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "05465f16-1a67-45f9-8f7b-a0f54ec04ed9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "91de644e-2861-49fc-97f5-f146756e95db",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d3c263cc-6f83-4460-8aeb-5a6deaab9ba3",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4dbbf072-d13c-47f2-975b-51f6cb7d334b",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ba51b6b3-7e35-4b09-be8f-3feecf3c73f0",
"EffectiveDate": "2026-05-17T11:26:35.2688284-07:00",
"StatusType": {
"StatusTypeId": "34d503b2-1dce-4ec5-92cf-3181b196412d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "05465f16-1a67-45f9-8f7b-a0f54ec04ed9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "91de644e-2861-49fc-97f5-f146756e95db",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a09edf30-3afc-4dd4-a2fe-057265c6f7e2",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6a820fe7-725c-4dcf-9afe-d41f9cb84965",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fda0cc1f-b0d1-4b2a-9f60-8922ef9ca7d7",
"EffectiveDate": "2026-05-17T11:26:35.2688284-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "40ccca8a-8cba-4715-aaa2-c159207121f1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "525867b3-ceb7-492b-ab82-c0574d9f6f5b",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a4cf972e-0ed0-4e0a-a9de-27b42c24040d",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-17T11:26:35.2688284-07:00",
"MeasurementValueNeededDate": "2026-05-17T11:26:35.2688284-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "31b1cca8-0964-49dc-a2d7-7e8fa7d74717",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "54b554c3-6e7f-4f74-90fd-471ae597de8f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "52c71a36-0295-4dd9-942a-00752cd45722",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-17T11:26:35.2688284-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7056720d-7464-4a34-b977-d2992ae46b36",
"CreateDate": "2026-05-17T11:26:35.2688284-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-17T11:26:35.2688284-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}