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": "143c1c02-5d62-44d5-92dc-c8968220cbe3",
"Asset": {
"AssetId": "e09c24a8-6482-4729-a419-006384e9215b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9a092216-82d9-4c2f-b763-61b0695f14e2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d5df4e0d-3e6c-4362-baad-b120d74d5639",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c34ffe0a-b0ae-401c-9eb9-6c10980ef72c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T07:38:17.0669701-07:00",
"MeasurementValueNeededDate": "2026-03-13T07:38:17.0669701-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "608c82c6-f6de-4bad-8b79-231a0892cce3",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5f45eb43-ebe3-4624-b645-caf72123d20a",
"EffectiveDate": "2026-03-13T07:38:17.0669701-07:00",
"StateType": {
"StateTypeId": "a8d44acf-d1c7-4ad5-a430-99b9f6a40a3e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9a092216-82d9-4c2f-b763-61b0695f14e2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d5df4e0d-3e6c-4362-baad-b120d74d5639",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6d123d93-f870-4152-998f-e0063c22c92f",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5531e0f6-6921-4b88-b549-23122518f3a6",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "833b2010-f831-455a-8e31-7e45250045f9",
"EffectiveDate": "2026-03-13T07:38:17.0669701-07:00",
"StatusType": {
"StatusTypeId": "d011193d-ddf3-413c-972f-5276caa7f1af",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9a092216-82d9-4c2f-b763-61b0695f14e2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d5df4e0d-3e6c-4362-baad-b120d74d5639",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "45f15423-0734-456b-8fbe-e545ae0bae69",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ee057199-ee6b-483b-bf70-dd10f89cacae",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ec5fc05e-53f2-44b9-a89f-59e524fa1222",
"EffectiveDate": "2026-03-13T07:38:17.0669701-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e035ab17-f849-4aa7-a7a8-5c7e270d3205",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a05366ca-3f84-4e4b-8b42-1e1f9ba5bdb2",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7d51c86c-d8c2-459f-b5ae-b9407f863487",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-13T07:38:17.0669701-07:00",
"MeasurementValueNeededDate": "2026-03-13T07:38:17.0669701-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cc3f57ff-03a0-4d48-91b7-adf5c842533d",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "136849bf-f8cb-4966-a82e-8005cc9c25a6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7de21ed0-79da-4af6-93d8-c47294a63daa",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-13T07:38:17.0669701-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a619989d-ee33-4221-a37c-4d9013bbc88c",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-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": "9fac913e-96d8-4404-90ce-6e2123d14f3b",
"Asset": {
"AssetId": "3fcfc525-df76-4316-8cd9-dc0b3524e1a4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "865a8557-e7bb-4d19-a17d-60ad0f6a1352",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "45df50f9-7501-4f1c-bc5c-c86b9fe93308",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8ca8ded6-175b-4b14-a3e4-0ecd7b7825a7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T07:38:17.0669701-07:00",
"MeasurementValueNeededDate": "2026-03-13T07:38:17.0669701-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "03746f96-a22e-43cc-add4-8c5faa8bcc1f",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "eadfbe25-fe33-4789-94a1-5f176dc2044a",
"EffectiveDate": "2026-03-13T07:38:17.0669701-07:00",
"StateType": {
"StateTypeId": "33622323-40c2-49b7-8427-004cc7a2714b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "865a8557-e7bb-4d19-a17d-60ad0f6a1352",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "45df50f9-7501-4f1c-bc5c-c86b9fe93308",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "26e14fcb-4fc1-4194-ba58-ca4dec849458",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cb208e1e-a3f6-4145-8a84-4a88af628c74",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1a981a98-c152-4b4e-a1b3-dc7e58c51912",
"EffectiveDate": "2026-03-13T07:38:17.0669701-07:00",
"StatusType": {
"StatusTypeId": "84449bf9-df5b-4639-8cd2-3dfb7152b3d9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "865a8557-e7bb-4d19-a17d-60ad0f6a1352",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "45df50f9-7501-4f1c-bc5c-c86b9fe93308",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7c0fa4df-b582-486a-9e63-515cdd5d1fd9",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b8f1657b-1249-497c-833a-56fc6ad66385",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "dd95770c-9ea9-4835-a8af-a231323b1a24",
"EffectiveDate": "2026-03-13T07:38:17.0669701-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4518d068-8b92-4fe6-a88e-37ef2c595cc6",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "785aab9a-fbd0-4b2e-85fc-873bbe244442",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9cc02a03-1876-457b-b462-d3fe4d6f6d3b",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-13T07:38:17.0669701-07:00",
"MeasurementValueNeededDate": "2026-03-13T07:38:17.0669701-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ce5a95a8-80c1-4486-8b74-334e9578657e",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5319c3e4-8c1b-4af5-8c7e-4da053879cdd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "eba61ee1-37f5-4536-b9ee-4ec3cea42bd3",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-13T07:38:17.0669701-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "207d952f-fe6c-4f15-940d-04bd6ecf32b7",
"CreateDate": "2026-03-13T07:38:17.0669701-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T07:38:17.0669701-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}