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": "214d7bc3-5958-4b19-92c6-31c067799e28",
"Asset": {
"AssetId": "de66a202-4dd8-4ac7-be10-1461c7ad30d1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4c3db077-4307-4409-86ac-7ed375fb88c3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f26f1e74-a40c-4122-a000-1ae9c4acc178",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f00c37ef-1a8b-4365-9b5d-a4c4da90ff67",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-30T23:17:23.8939734-07:00",
"MeasurementValueNeededDate": "2025-07-30T23:17:23.8939734-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2f421695-1caf-439d-a77c-5af57a6f62a0",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3cf98068-bfc8-460e-ad04-2d908647882d",
"EffectiveDate": "2025-07-30T23:17:23.8939734-07:00",
"StateType": {
"StateTypeId": "3094d9d6-6555-4fc2-a215-329b40c6f9a2",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4c3db077-4307-4409-86ac-7ed375fb88c3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f26f1e74-a40c-4122-a000-1ae9c4acc178",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e637fbb7-1cb7-42cc-8fcb-ef94068639fa",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1d48c7b5-833d-44dd-b64a-fc313a14ddd5",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "6c3f72a4-f147-4392-831f-55dea68a0ba6",
"EffectiveDate": "2025-07-30T23:17:23.8939734-07:00",
"StatusType": {
"StatusTypeId": "57c6fbb5-080b-4cf5-872a-86aa0dbdf044",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4c3db077-4307-4409-86ac-7ed375fb88c3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f26f1e74-a40c-4122-a000-1ae9c4acc178",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "71eb5ddb-b43c-4831-a864-441b59ff6542",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "946311b8-7d5a-4ba4-b0b0-01e52eb6d65c",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "985b0f6b-c7dd-4bba-9ec0-77b02c338595",
"EffectiveDate": "2025-07-30T23:17:23.8939734-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "74cd7969-ca42-44ff-b149-3c90340ec92b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1143115a-1ee6-44ae-9320-c26217334292",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8b73338f-3acb-44ec-99fc-301d89dcc9c1",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-30T23:17:23.8939734-07:00",
"MeasurementValueNeededDate": "2025-07-30T23:17:23.8939734-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ed80be1c-8dd2-48d8-a509-4b1586dcd30c",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "555f0a3c-eb5d-4ac8-8fd6-e2da7ac8a79d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b7fbe5fa-40d2-4800-b533-f3029f5b4092",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-30T23:17:23.8939734-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "075afdd7-f4b7-42b4-b22d-7de551a979a1",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-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": "b12c120c-d7e7-4559-bc23-f20925e06da9",
"Asset": {
"AssetId": "aef6521e-428e-4a6e-8eba-264afb8f8031",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b4e7e592-a14b-4c8c-9133-38068f0e038d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "204a053b-7bc1-4b29-8bb5-386d20c44f5b",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e6755e76-b67d-4f8c-9c59-f2428d0375e4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-30T23:17:23.8939734-07:00",
"MeasurementValueNeededDate": "2025-07-30T23:17:23.8939734-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b60d6cc4-29ba-480c-be32-8ebf50898698",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2b65a804-911e-4613-8b00-97659b3eb876",
"EffectiveDate": "2025-07-30T23:17:23.8939734-07:00",
"StateType": {
"StateTypeId": "cc6717e9-ab95-4696-8457-0d13316aa0e6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b4e7e592-a14b-4c8c-9133-38068f0e038d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "204a053b-7bc1-4b29-8bb5-386d20c44f5b",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "912f1552-8b50-42f6-afff-06ff93d49ef5",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "88328fc5-0038-4cd4-930d-c84e475d993b",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0b593f0f-b55f-41a2-9b7b-d47e897e165d",
"EffectiveDate": "2025-07-30T23:17:23.8939734-07:00",
"StatusType": {
"StatusTypeId": "28c983a6-2672-4144-9593-a1e6b752bb63",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b4e7e592-a14b-4c8c-9133-38068f0e038d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "204a053b-7bc1-4b29-8bb5-386d20c44f5b",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "482ba5c9-5bd7-4a08-8c00-8a7952ea019e",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d624d76c-d034-4e6a-8d75-9dc2b1db60a6",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d31fcb60-c6cd-40b9-88fb-495afa2e23c8",
"EffectiveDate": "2025-07-30T23:17:23.8939734-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8cfbcace-29be-4b8a-91f2-dd58cd2179f1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a48cc4bb-6afd-4d27-b605-4245f7aa0655",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a400d703-9513-42b1-9ff6-00f5528b2f45",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-30T23:17:23.8939734-07:00",
"MeasurementValueNeededDate": "2025-07-30T23:17:23.8939734-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fc13edc4-34e3-4f05-ae37-843d4b078157",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "19a9f98b-d6f2-4a54-8310-fd264dc36154",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4184fbef-1b8b-42a8-b581-62607c9e3773",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-07-30T23:17:23.8939734-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2a1afae3-16e2-4b71-ace6-422d13afbd23",
"CreateDate": "2025-07-30T23:17:23.8939734-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-30T23:17:23.8939734-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}