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": "aebe7b37-a9d6-4a4a-af97-d68ab0f5a018",
"Asset": {
"AssetId": "c7afbaff-d950-442a-a2f8-f48bfd0586fc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "54a9c5fa-3389-4f25-ae17-a764228dcf69",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fc748019-349b-47c3-87f4-c1b03ba99969",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "028e7597-2c82-4f3a-a431-2b315d868216",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-02T21:51:39.1712455-07:00",
"MeasurementValueNeededDate": "2026-08-02T21:51:39.1712455-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5f8207ec-5a02-4bfc-abd2-433b83de4069",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1d2358df-8a4d-434d-be97-ad5747c092f5",
"EffectiveDate": "2026-08-02T21:51:39.1712455-07:00",
"StateType": {
"StateTypeId": "e52679e1-9030-445c-ab82-ad89002f9082",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "54a9c5fa-3389-4f25-ae17-a764228dcf69",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fc748019-349b-47c3-87f4-c1b03ba99969",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "25aeba92-02bc-49d1-9afb-793073643c83",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "672a39df-9b04-48f9-9522-a94168305ef2",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "61454688-9526-4bc0-a8e5-be8957137f3e",
"EffectiveDate": "2026-08-02T21:51:39.1712455-07:00",
"StatusType": {
"StatusTypeId": "213d2613-d767-4926-ab6f-2cda7c408497",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "54a9c5fa-3389-4f25-ae17-a764228dcf69",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fc748019-349b-47c3-87f4-c1b03ba99969",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1a5743b0-32d8-48e2-8179-b516b74e5aad",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "307e3f5e-d077-4c45-948e-7b601131e968",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "752a6985-a16e-4a06-af2e-765d4b6c013a",
"EffectiveDate": "2026-08-02T21:51:39.1712455-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a4f94df2-8a5c-42c7-bc72-c221b3d0add1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a4ed9770-a1e8-4503-b670-71332c0c1faa",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "711db9d4-d4e7-4823-b71f-a9fdc378568c",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-02T21:51:39.1712455-07:00",
"MeasurementValueNeededDate": "2026-08-02T21:51:39.1712455-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "633f575a-0b7b-4265-8ae3-7157e985e1c7",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "962d9d0f-36db-4da4-b411-5e562f40e32d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7a06142a-1c4b-4439-ad11-0d97032854ae",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-02T21:51:39.1712455-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b809f7f5-353b-4055-af58-44b72f6db3dc",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-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": "2f052683-145e-4e8f-bccb-de6e6a058160",
"Asset": {
"AssetId": "a83dc6de-22f9-4aa8-a7af-1e2d6bcdd47f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b12df9ee-6891-4803-84a7-9aaed5d71883",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a27722ad-1e92-46fc-a15d-d9bc6b206255",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b277cc35-396c-4631-a80d-faf3a3c4126f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-02T21:51:39.1712455-07:00",
"MeasurementValueNeededDate": "2026-08-02T21:51:39.1712455-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "67da4ba6-6730-4968-a6e0-ef8519cd2345",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7e0f1d46-81f6-4cc5-be09-9337c3a26652",
"EffectiveDate": "2026-08-02T21:51:39.1712455-07:00",
"StateType": {
"StateTypeId": "a026779c-3884-47c8-b8d2-3217d9248e91",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b12df9ee-6891-4803-84a7-9aaed5d71883",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a27722ad-1e92-46fc-a15d-d9bc6b206255",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "24a23501-77e6-49ee-913b-e7e55108dfd4",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dab32c05-96f9-443b-9346-1041686d3fcb",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8c5480bd-c47e-4994-83e7-d7753e42b9e9",
"EffectiveDate": "2026-08-02T21:51:39.1712455-07:00",
"StatusType": {
"StatusTypeId": "0988c875-0271-4220-9fb4-0eaae9ee1487",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b12df9ee-6891-4803-84a7-9aaed5d71883",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a27722ad-1e92-46fc-a15d-d9bc6b206255",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1f5e6f95-67ed-43bf-8d9e-9dabaddffb9d",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7e7b030a-f24b-4184-b9b2-ad4526e4a790",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f5f3ebed-8e7e-4281-a299-90091fa9e5da",
"EffectiveDate": "2026-08-02T21:51:39.1712455-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "05cc8353-551f-4b4e-84c8-a08f04944346",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "35107b67-b91e-4a6a-b299-2c3ab6610529",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4bd29d98-ddcc-48ec-ae3d-eb5062d038e0",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-02T21:51:39.1712455-07:00",
"MeasurementValueNeededDate": "2026-08-02T21:51:39.1712455-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6a36fdde-10b0-4134-bb6b-f73d29c76f17",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "d94914fd-c057-4bf1-b1a2-e2ecab51a9ba",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "abfe59fd-0ab7-4ae5-a607-44069e5fa5a5",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-02T21:51:39.1712455-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "16189204-25b1-490f-b8a0-831a93d34aac",
"CreateDate": "2026-08-02T21:51:39.1712455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-02T21:51:39.1712455-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}