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": "82b321a9-2e70-49fe-9d0b-84dade9e9fee",
"Asset": {
"AssetId": "d2614b85-e7d0-4a2b-9ec6-b2370c477a92",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0d0541fd-b377-4a28-a2fe-621558b545f0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "68cae628-3a56-48d2-a5d0-afb76be98e26",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d4b853c9-aa76-46e4-92b7-2ed6b6886d86",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-31T12:13:59.1384636-07:00",
"MeasurementValueNeededDate": "2026-05-31T12:13:59.1384636-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f4f137c8-1b35-4956-ae46-8e6fe3771662",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d2bc0a4c-4858-418c-8064-d056bf3c23a9",
"EffectiveDate": "2026-05-31T12:13:59.1384636-07:00",
"StateType": {
"StateTypeId": "21083fe3-77bc-493e-815e-3b4abd116cb8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0d0541fd-b377-4a28-a2fe-621558b545f0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "68cae628-3a56-48d2-a5d0-afb76be98e26",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "dcd1c5db-2ce9-4aa2-afb8-9efa9cc71495",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "63ef9fb1-528f-49d2-94de-2533764d953b",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8d5917ba-4789-461c-800c-82ae5bb73749",
"EffectiveDate": "2026-05-31T12:13:59.1384636-07:00",
"StatusType": {
"StatusTypeId": "e5ce5f03-2826-405c-aadd-4a1e8aae660e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0d0541fd-b377-4a28-a2fe-621558b545f0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "68cae628-3a56-48d2-a5d0-afb76be98e26",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7b9e72ca-a437-4960-9a6c-0eece9b192c4",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "27a7bfc2-b668-4f4f-a27f-f39250ebd9de",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b99e9c2a-29ef-4493-aa67-d9dea2621054",
"EffectiveDate": "2026-05-31T12:13:59.1384636-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8435bb87-0633-4a4f-96bd-bc473e7160c0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "69be6ec5-ea87-4abc-88fd-e8a745dd7107",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7229f49b-c4f1-4007-9452-40cac71c4d01",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-31T12:13:59.1384636-07:00",
"MeasurementValueNeededDate": "2026-05-31T12:13:59.1384636-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a3ec35dc-afaf-4812-bec9-1ded24f54a11",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b30f80ab-c09f-4f71-b62b-28a590a5db97",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1b361289-2de5-48c1-9df1-2d9da18baf86",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-31T12:13:59.1384636-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "79d9e77e-eb5f-454b-bdcc-07ece2cc51c8",
"CreateDate": "2026-05-31T12:13:59.1384636-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-31T12:13:59.1384636-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": "4e13a851-d9ec-439f-8a21-28088989755e",
"Asset": {
"AssetId": "4588838f-d23c-456c-bbcf-652ad1ed8b5f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9819acc7-2971-4441-acde-6c3d53b62ddd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7f843205-5319-43e4-8c62-dbed270c8bba",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "59ac04c7-741b-4bd6-a34e-ad3db2917cf1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-31T12:13:59.1541961-07:00",
"MeasurementValueNeededDate": "2026-05-31T12:13:59.1541961-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b1105883-ff7d-48d4-a96b-34fc013a9a27",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "9a75f99a-357f-4a37-930b-4c83334a1c0f",
"EffectiveDate": "2026-05-31T12:13:59.1541961-07:00",
"StateType": {
"StateTypeId": "19255203-560b-4f31-9b64-42bd8bde048a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9819acc7-2971-4441-acde-6c3d53b62ddd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7f843205-5319-43e4-8c62-dbed270c8bba",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "625e9c25-ae28-4df1-afad-200accbe0b1f",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3e981428-97ff-4c7f-9463-e3e1424358a1",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d99058ae-0a97-4469-9576-4fb8acaa4160",
"EffectiveDate": "2026-05-31T12:13:59.1541961-07:00",
"StatusType": {
"StatusTypeId": "8b3fdd40-75b3-4faf-9a2a-bf3c6e00f1f0",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9819acc7-2971-4441-acde-6c3d53b62ddd",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7f843205-5319-43e4-8c62-dbed270c8bba",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f76c071a-8634-4f48-8dc3-7a6b8517cc52",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2712e6b6-e729-4d48-8826-1acf793f0dc8",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c21a3eee-4db3-41df-a208-ee86f0165386",
"EffectiveDate": "2026-05-31T12:13:59.1541961-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e2648a1c-f178-480f-a515-47f3c24635f9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1da03ec0-9928-4b24-886a-3f85c2a4858f",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f85a867f-3e5e-4c52-a64b-20f3d96eae95",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-31T12:13:59.1541961-07:00",
"MeasurementValueNeededDate": "2026-05-31T12:13:59.1541961-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f54248c5-fadb-4a57-a678-d988e350c31b",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b829bded-5036-43a4-b1f6-8e8a8a457cd1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d25ce6d3-96f4-4c52-9e10-f56a63a08672",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-31T12:13:59.1541961-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e88254bd-1bb7-4345-8f09-43b8a4eb92f1",
"CreateDate": "2026-05-31T12:13:59.1541961-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-31T12:13:59.1541961-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}