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": "81d9ddec-e995-42a8-9c14-b01b5e1f770a",
"Asset": {
"AssetId": "2332a49a-e2b7-4d30-9705-95dce70824c9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "35fad1dd-1dad-4284-bf42-3b44ada0a95e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9f6aa266-bc30-45ae-b0bc-dc1dbddc28c5",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ef105c9a-d813-418c-b18b-e7633e745c46",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-27T06:34:43.4876451-07:00",
"MeasurementValueNeededDate": "2025-06-27T06:34:43.4876451-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "399091c9-94c2-4749-9485-c8101ace1d1d",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ed5dd9c1-2f74-4586-85ba-fc5fe27064d3",
"EffectiveDate": "2025-06-27T06:34:43.4876451-07:00",
"StateType": {
"StateTypeId": "55c1736c-86fa-4796-8f87-5ee2559225c6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "35fad1dd-1dad-4284-bf42-3b44ada0a95e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9f6aa266-bc30-45ae-b0bc-dc1dbddc28c5",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2b12d7f0-1215-4afc-849c-e86179a12712",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bfa6311b-94ae-44b8-b2b0-1a529a0c1508",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1bc230a9-e821-460e-8ee8-dafcfa4b76ca",
"EffectiveDate": "2025-06-27T06:34:43.4876451-07:00",
"StatusType": {
"StatusTypeId": "ab4f6419-58f2-4ce9-af0d-5d6c2d05d459",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "35fad1dd-1dad-4284-bf42-3b44ada0a95e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9f6aa266-bc30-45ae-b0bc-dc1dbddc28c5",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e1af5399-3804-44d3-afc4-6b188e8e4514",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1d48e682-c7b4-44f7-9916-fdc0c71f67ac",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d8f3b83b-47cf-43a2-b8b5-0dbb29028b5e",
"EffectiveDate": "2025-06-27T06:34:43.4876451-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4dec3b93-4fd2-4e16-b675-2bf2f58cafc2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "97a0f064-d162-4ab2-8b61-e47fe87dd1ab",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "20ef4639-0850-4d3f-876d-2f74f36908e2",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-27T06:34:43.4876451-07:00",
"MeasurementValueNeededDate": "2025-06-27T06:34:43.4876451-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b380a53d-5b66-48be-9f69-f6ee5bdde04f",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "87d48578-8858-4c0e-990f-3743bc3fed30",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "74e5cf8d-3240-456c-82d3-c65ef99498b2",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-27T06:34:43.4876451-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e76b5088-7dfc-4f01-bc79-26b68f571f4d",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-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": "9c7d333e-8f25-4197-98a3-d971a17652cd",
"Asset": {
"AssetId": "0186f6b2-c943-424c-801d-da806f93ab71",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5042a5da-807b-4965-8737-8c84dafa906b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "28c32350-918c-4647-9bfa-e8759b501e3e",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4d8ce56b-9aa5-419a-a0f9-d907ed16ea8c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-27T06:34:43.4876451-07:00",
"MeasurementValueNeededDate": "2025-06-27T06:34:43.4876451-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2f1d2e0e-99c5-48da-a43d-f5c43923caab",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f9cd5e3b-421f-4227-a528-9c502fb8cd8b",
"EffectiveDate": "2025-06-27T06:34:43.4876451-07:00",
"StateType": {
"StateTypeId": "9dfec5ae-0d17-4f1a-b180-d394978de269",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5042a5da-807b-4965-8737-8c84dafa906b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "28c32350-918c-4647-9bfa-e8759b501e3e",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0fd56fa7-21b4-41d3-bafa-267d386e8109",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6201adec-f500-4c79-b4ee-e1db2f82b166",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "04ee2247-15e2-401e-9415-c7e9cb6bb971",
"EffectiveDate": "2025-06-27T06:34:43.4876451-07:00",
"StatusType": {
"StatusTypeId": "5b3d5d0e-f184-4799-80ff-5fdae4e45aff",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5042a5da-807b-4965-8737-8c84dafa906b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "28c32350-918c-4647-9bfa-e8759b501e3e",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6d689da1-1b39-4531-ab70-2e92b6c6585d",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "faa6d83a-9363-4f70-875c-3e57d7a3276e",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "084e7a52-3c5c-4cdd-a86f-63a04ff7966c",
"EffectiveDate": "2025-06-27T06:34:43.4876451-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "ab26e11e-0f76-4db3-bc4d-29026e10966b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e264107e-7d60-47ec-ba90-b8ed8ec8ab32",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "56e9d691-44d8-4c57-a95f-bf7fa179276a",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-27T06:34:43.4876451-07:00",
"MeasurementValueNeededDate": "2025-06-27T06:34:43.4876451-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "84b13b64-cb85-492e-84fe-ef1bf6836e27",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "49e87e05-9acc-4241-8d3a-212a19c1825b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cc6bb7d2-3bde-4c3b-a272-89f313aba096",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-27T06:34:43.4876451-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e459521f-49d5-4bf9-bf9c-124eae0b2347",
"CreateDate": "2025-06-27T06:34:43.4876451-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:34:43.4876451-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}