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": "c10ab995-2ad6-4712-a87b-e9689e46b465",
"Asset": {
"AssetId": "f3462b29-3ef5-4f87-be0e-8922bf0a8b06",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8d7d4bbb-5ba9-4883-a933-83378a1fa260",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93300439-2560-401c-80d4-7c116a933992",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4aaa268a-4b21-436d-a079-2137dda02a66",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-05T10:44:13.3638633-07:00",
"MeasurementValueNeededDate": "2025-08-05T10:44:13.3638633-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a155fe61-0c43-4f2f-a118-cef381613f47",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e2c12394-86ec-427a-9dea-c4f8e02c99c9",
"EffectiveDate": "2025-08-05T10:44:13.3638633-07:00",
"StateType": {
"StateTypeId": "159d07f1-1543-4953-9487-3fbfef76c50f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8d7d4bbb-5ba9-4883-a933-83378a1fa260",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93300439-2560-401c-80d4-7c116a933992",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3a7cda41-5214-4b6c-a6ab-bee2a2d5e4b3",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4584c283-24ab-4b3b-b71b-5aa5010bcd16",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "aad79efe-fe58-4c7c-9eb7-5691645f0c7d",
"EffectiveDate": "2025-08-05T10:44:13.3638633-07:00",
"StatusType": {
"StatusTypeId": "3710de7f-6a87-40b6-b8dd-30453efda1f9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8d7d4bbb-5ba9-4883-a933-83378a1fa260",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93300439-2560-401c-80d4-7c116a933992",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "75ad8ea4-f5f1-40d3-af30-9eee23aa87f4",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1b68fd47-36db-4faf-b92e-df29e63210d1",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "db689221-f7f3-42e8-b259-aa393eda3fc1",
"EffectiveDate": "2025-08-05T10:44:13.3638633-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0a4edab8-d4fc-42f5-80b5-2908dd9b55c1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4c505812-fa20-4d98-b35b-987e07025c38",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "67075eeb-e9d0-4e31-bc46-99e09014f0f4",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-08-05T10:44:13.3638633-07:00",
"MeasurementValueNeededDate": "2025-08-05T10:44:13.3638633-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "109bf8f4-93cf-4c9a-bb96-d16d0162bd59",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "1105eccb-332d-4c8a-862c-bb268a9303bf",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "df01de53-ae3f-472c-b453-38b3fad32ac6",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-05T10:44:13.3638633-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c155f4e6-5b7d-4907-81c1-2c4dec73c3ff",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-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": "60a90726-1d1e-44f7-a704-698e70874abb",
"Asset": {
"AssetId": "c5d9d441-5d24-4a9c-8498-9414317de654",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5ed0ed04-e663-40a4-a6a2-b8e24db68b19",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9df118aa-baea-4867-a368-af4e335a0453",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e45efc11-905d-4ef0-aa9a-40d6426ead16",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-05T10:44:13.3638633-07:00",
"MeasurementValueNeededDate": "2025-08-05T10:44:13.3638633-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3df78794-2f5c-4cf8-8988-15d18734619e",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "45e87c94-f08a-4ce7-a24c-554794db9e4d",
"EffectiveDate": "2025-08-05T10:44:13.3638633-07:00",
"StateType": {
"StateTypeId": "2a5732e9-2efe-4384-84ba-04fc822e7d70",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5ed0ed04-e663-40a4-a6a2-b8e24db68b19",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9df118aa-baea-4867-a368-af4e335a0453",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e46c5306-5e70-4b7b-b3d2-ee9fb4fd2fd7",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1793cf9c-b9b6-408e-915e-0b56cebb456f",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f6be7600-0a8e-49f3-8680-22ee10c26f60",
"EffectiveDate": "2025-08-05T10:44:13.3638633-07:00",
"StatusType": {
"StatusTypeId": "ca9f9e4f-666d-4eaa-b5bf-24e65bb1d5a1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5ed0ed04-e663-40a4-a6a2-b8e24db68b19",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9df118aa-baea-4867-a368-af4e335a0453",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7c4abb20-0a48-428c-8c6c-2651de437120",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b6e97cb9-43b1-43a0-9df1-4abf62903252",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "33c78e5d-8be4-440c-a54c-cac5e014a8cc",
"EffectiveDate": "2025-08-05T10:44:13.3638633-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b19d19d7-b860-4196-abc1-c4313dbabcbf",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "172f76b3-214f-4c32-a1e7-e674318d64f3",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "67f3f620-1164-4e9a-935a-b5543e3df659",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-08-05T10:44:13.3638633-07:00",
"MeasurementValueNeededDate": "2025-08-05T10:44:13.3638633-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c3a9fd8d-0805-451b-8059-a4de11b5eb85",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "7fac44bf-6a96-4db5-bee0-319506f18ed7",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "08d431ef-f184-41b9-b124-63b66361cff0",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-05T10:44:13.3638633-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f4122f4e-c5b9-4c6a-b592-236bb3609210",
"CreateDate": "2025-08-05T10:44:13.3638633-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:44:13.3638633-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}