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": "824b46a0-26ef-464d-9098-4dbcb8e96fff",
"Asset": {
"AssetId": "1146bd31-844f-4200-ab8d-814f408da0d2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "52058890-3fd6-4ce5-98dd-1242cd1fcdea",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "abd51362-9dce-48a5-925f-84b96944f3c1",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "93dbe38d-101e-4685-88f5-c6b817cd9dc7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-16T10:17:57.3216085-08:00",
"MeasurementValueNeededDate": "2026-11-16T10:17:57.3216085-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3ec9081a-1f0e-4f8f-9264-08ec4063f89e",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "391aa4fb-95ca-46af-ae5e-8b6ebffcdbe1",
"EffectiveDate": "2026-11-16T10:17:57.3216085-08:00",
"StateType": {
"StateTypeId": "32831b6a-7b55-4705-9e19-03a662f91d31",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "52058890-3fd6-4ce5-98dd-1242cd1fcdea",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "abd51362-9dce-48a5-925f-84b96944f3c1",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f2ba8b00-ea84-4eb4-85b5-c500f81cb398",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5bb0e10b-707d-46d6-a454-f9910e49706a",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "078fa264-f81a-49f4-9728-75414d40b3fe",
"EffectiveDate": "2026-11-16T10:17:57.3216085-08:00",
"StatusType": {
"StatusTypeId": "343a199c-0cf9-4c34-a895-56df3e7680ef",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "52058890-3fd6-4ce5-98dd-1242cd1fcdea",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "abd51362-9dce-48a5-925f-84b96944f3c1",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5a1846c4-c176-488e-bd7a-28183561dea8",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "936f3e0c-c6f6-4583-99a6-efc0f5d37f6e",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "879ed065-0207-4217-9049-1cbddaa10991",
"EffectiveDate": "2026-11-16T10:17:57.3216085-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "292fbb19-0f30-4996-893c-345de20e3f26",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ef92a384-b664-4b75-bc06-d58a45362fc7",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a56599f1-9a5c-4924-ba94-9d3f8ea2c968",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-16T10:17:57.3216085-08:00",
"MeasurementValueNeededDate": "2026-11-16T10:17:57.3216085-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e0abfa1c-dadc-491b-a6d0-b1c09c53eb30",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "8a758445-07df-4ea9-b57d-98600c1bae99",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2c4457f6-6114-4485-8940-65e9fa8e887a",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-16T10:17:57.3216085-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fcf64d9f-bea8-4aea-8f4c-e0d9495cb97a",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08: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": "fcd2afe2-5419-4a39-a8b4-9090515550ca",
"Asset": {
"AssetId": "c45777b7-7328-4e2c-8f59-df6e8d89a397",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "07d7567a-3864-42fd-9dc2-d0a1dc48f18c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "abbf4786-cf74-4ceb-8fcc-3f1f5a562d7e",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "32697e9a-2eb3-4cf9-b44b-d3047e3748ce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-16T10:17:57.3216085-08:00",
"MeasurementValueNeededDate": "2026-11-16T10:17:57.3216085-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ea37346b-0688-4b86-a0eb-034843e846ea",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f1c8b9d9-b4ec-4cd8-8cee-f35cf2462b0f",
"EffectiveDate": "2026-11-16T10:17:57.3216085-08:00",
"StateType": {
"StateTypeId": "07e24430-f459-448b-b36b-e949c4bd5d75",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "07d7567a-3864-42fd-9dc2-d0a1dc48f18c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "abbf4786-cf74-4ceb-8fcc-3f1f5a562d7e",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c114491b-5df9-438e-9816-b79d206246fe",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9af8d964-fdcd-4c7c-898e-9c81f7dd4f43",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "38968108-4275-401c-899b-691271870dd4",
"EffectiveDate": "2026-11-16T10:17:57.3216085-08:00",
"StatusType": {
"StatusTypeId": "4b9a7a4f-a3cd-48d7-a39b-2fe5ddcfc772",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "07d7567a-3864-42fd-9dc2-d0a1dc48f18c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "abbf4786-cf74-4ceb-8fcc-3f1f5a562d7e",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6ee6b057-6edf-48a4-8721-7a4a4f0341e4",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a44f449d-223e-4501-8c8d-503e9773ad57",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5ba13597-e68a-4ab3-a0c9-da93a2a13b14",
"EffectiveDate": "2026-11-16T10:17:57.3216085-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "b91cfefe-8eef-47f8-807f-b822de08cb55",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c6fbfa0f-87aa-4293-a708-f2f47532a798",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a07eb4b2-04aa-442b-bc30-e3e928e3984b",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-16T10:17:57.3216085-08:00",
"MeasurementValueNeededDate": "2026-11-16T10:17:57.3216085-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e14b32ed-0ae3-45ff-a3a4-bf5060677d6f",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5d253d8c-3066-4f5d-aab7-8bb76ceefa89",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "36a8cd06-f2e8-4138-bd69-a6b6631b9f7e",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-16T10:17:57.3216085-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "66045b0d-5696-4a95-9fa1-6332e655a408",
"CreateDate": "2026-11-16T10:17:57.3216085-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-16T10:17:57.3216085-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}