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": "92f9d242-b17a-4d30-ade8-d7605b6da61d",
"Asset": {
"AssetId": "178c934d-2b1f-4827-8126-2a154d65059d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4c494124-f879-49b9-bd27-608c66026453",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "814978e2-5fcb-480b-b52b-b60674cccede",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "310fd1bb-9c9e-493d-ab7d-e106811d704b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-24T11:32:33.3120858-07:00",
"MeasurementValueNeededDate": "2026-05-24T11:32:33.3120858-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b83e7080-a292-41d4-9976-259cd7348f13",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "328423f0-d033-4de7-b0f5-b4aeaa963578",
"EffectiveDate": "2026-05-24T11:32:33.3120858-07:00",
"StateType": {
"StateTypeId": "ac9afd68-6afe-45e4-9219-3b4fe56b05bd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4c494124-f879-49b9-bd27-608c66026453",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "814978e2-5fcb-480b-b52b-b60674cccede",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8b163dba-173a-4c84-9037-60f0389d5373",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8a1f351b-c842-4326-bf7f-a18a49423188",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c9a8b789-9429-4f83-9636-7006bee50f56",
"EffectiveDate": "2026-05-24T11:32:33.3120858-07:00",
"StatusType": {
"StatusTypeId": "a6bd5564-522f-49f1-bb85-af845b7c5288",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4c494124-f879-49b9-bd27-608c66026453",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "814978e2-5fcb-480b-b52b-b60674cccede",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8c91c8cd-5a0a-4d27-a4fe-589d7323f749",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bf8fcdda-d7c1-4efc-ad28-cf6b6f87b79d",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ed460cae-90b2-465b-a80b-7a1ff5cd29d5",
"EffectiveDate": "2026-05-24T11:32:33.3120858-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3be5f22b-03f9-4ddf-af6a-c0152bd60ef7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "22d997dd-c2f8-45d9-9a57-d3ebcfecb102",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1b5041f4-48cc-4995-9211-a78031173e7e",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-24T11:32:33.3120858-07:00",
"MeasurementValueNeededDate": "2026-05-24T11:32:33.3120858-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ced9ddd6-33aa-4587-9f02-3f3c23f99142",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4aa376b6-02cf-4fe6-b7d9-3723287c40c5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3c812259-c003-4668-ab57-4a8e42c64eb5",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-24T11:32:33.3120858-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "995e107d-ed6e-4478-9ff3-4eb53ab78e25",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-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": "db29d7fe-dda2-41a3-836f-c564bca226d1",
"Asset": {
"AssetId": "d806a219-9a63-4aa5-9501-73aded6b8ac4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0323086e-8822-48fd-be47-da8b3d27973a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "31d6af21-fb03-4a65-9505-5af004d3a37e",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9f3fa422-401b-46bb-b2a0-878d23346297",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-24T11:32:33.3120858-07:00",
"MeasurementValueNeededDate": "2026-05-24T11:32:33.3120858-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5d32e6df-d631-4eb5-9b4a-56a9bab9b2e4",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b9e02f25-bf1b-484b-8efa-b72195581f8f",
"EffectiveDate": "2026-05-24T11:32:33.3120858-07:00",
"StateType": {
"StateTypeId": "91f6b207-ae3e-4e0f-829d-70220879c0b0",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0323086e-8822-48fd-be47-da8b3d27973a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "31d6af21-fb03-4a65-9505-5af004d3a37e",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9da8b8a3-722c-43c7-92fe-a1b314723cfe",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e14cc05b-014b-4f60-893b-a117c0da79fe",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "64c8161c-3268-4147-9ce4-241756e87182",
"EffectiveDate": "2026-05-24T11:32:33.3120858-07:00",
"StatusType": {
"StatusTypeId": "453630d9-0b1e-4bc8-b632-85c357fc0985",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0323086e-8822-48fd-be47-da8b3d27973a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "31d6af21-fb03-4a65-9505-5af004d3a37e",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "297641d2-e4b3-4b16-a04e-9262dcb4d99c",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "87bdc468-b6cc-4182-a43d-54b97b81705f",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4782d30d-39bd-498a-a91c-91215f9be4f5",
"EffectiveDate": "2026-05-24T11:32:33.3120858-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "ff0ce7eb-937f-4623-86c1-baee0a1efaee",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "48844db4-5679-4335-97f9-813de302a8e7",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5e41ca07-bf04-4d6a-ad8b-e2a324de422c",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-24T11:32:33.3120858-07:00",
"MeasurementValueNeededDate": "2026-05-24T11:32:33.3120858-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6d5dbda2-0b65-4288-8e87-bcea002a09f1",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "a5e411d0-d997-419c-b522-440484f6b201",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "59d4133d-506f-4593-ab66-1f184524a5bd",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-24T11:32:33.3120858-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "efc5f721-f90d-4647-95a2-013f929c90c2",
"CreateDate": "2026-05-24T11:32:33.3120858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-24T11:32:33.3120858-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}