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": "d6210187-bb93-4186-ae2d-5452ef62c4a8",
"Asset": {
"AssetId": "82ff7fce-1aba-4dac-9641-2ad96fd2506d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4d8408ab-d953-4df4-8a2e-bbdcc2ff2550",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a60c213e-0dcf-4072-99dc-0ab155e31f35",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f6f10054-41f0-4272-ab51-a42b6dea6215",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T15:23:49.6028026-07:00",
"MeasurementValueNeededDate": "2025-06-30T15:23:49.6028026-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "952395d4-7d39-4f6d-94b8-200a1e44584a",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d475f69e-1034-4330-9c27-66f157f68127",
"EffectiveDate": "2025-06-30T15:23:49.6028026-07:00",
"StateType": {
"StateTypeId": "18d97579-8d31-4d30-a32d-90bf9f11ceb0",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4d8408ab-d953-4df4-8a2e-bbdcc2ff2550",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a60c213e-0dcf-4072-99dc-0ab155e31f35",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ded29367-6ddf-4559-8f0d-8cc011134050",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "436a2c71-bb74-4f8e-bb94-4ac7b44d7211",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ef3618f4-336a-43e9-8421-30afebb0407d",
"EffectiveDate": "2025-06-30T15:23:49.6028026-07:00",
"StatusType": {
"StatusTypeId": "8a59a440-e197-4eca-a50b-447997ca7b93",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4d8408ab-d953-4df4-8a2e-bbdcc2ff2550",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a60c213e-0dcf-4072-99dc-0ab155e31f35",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7066c878-103c-4bc8-b4d0-dcbf823d1b1b",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b1e53756-7887-4b01-b807-d437f4375ef8",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ea02881f-ba8b-420d-91fe-a555ae5aa7dc",
"EffectiveDate": "2025-06-30T15:23:49.6028026-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "ff4884bf-a7e6-4f06-8737-22fea1d27eef",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fa95e22f-a309-423a-b838-00ba94a2444e",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "52fd0c34-ffb0-48fb-a4d0-bef6309dfce8",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-30T15:23:49.6028026-07:00",
"MeasurementValueNeededDate": "2025-06-30T15:23:49.6028026-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9ea67719-29d6-405a-b2d3-634bc72495e9",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6af6a90f-76e7-4136-9d8e-5689bd8a1afc",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7e91654c-587b-41b1-90b0-958e625af75f",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T15:23:49.6028026-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "796f88a9-f6e2-4ab2-94c3-b25b93e4f9c7",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-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": "5edecbc2-1e1d-4ffa-ac75-ae07c36f1cdd",
"Asset": {
"AssetId": "76addd8c-a805-4a47-a2ac-30d49479d7ee",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1191b9fa-e41d-4ede-9199-688ce6a28662",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7cb15d77-ca72-4e4d-843b-f50557afaf34",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "88cc0bd2-d516-4b29-9e01-4901e194e081",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T15:23:49.6028026-07:00",
"MeasurementValueNeededDate": "2025-06-30T15:23:49.6028026-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "90d0996a-1bc5-4f73-9bbc-98c772dfb84d",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "78c00901-c7db-4a1d-bd21-37d9a7be4d30",
"EffectiveDate": "2025-06-30T15:23:49.6028026-07:00",
"StateType": {
"StateTypeId": "8957f131-c3fb-4974-a0ec-f095caec4bdf",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1191b9fa-e41d-4ede-9199-688ce6a28662",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7cb15d77-ca72-4e4d-843b-f50557afaf34",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "83016e80-c1ae-4b3f-83f0-28a0ccfb7540",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "73520ddc-3cf7-4475-8818-f36127072ba9",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0183112b-5226-4b99-b60b-d274e62a86e0",
"EffectiveDate": "2025-06-30T15:23:49.6028026-07:00",
"StatusType": {
"StatusTypeId": "cac3db1f-c98b-4b86-a5d3-12f25d251487",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1191b9fa-e41d-4ede-9199-688ce6a28662",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7cb15d77-ca72-4e4d-843b-f50557afaf34",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "593676b9-2ea1-4e24-a05e-a6dd4a659fb1",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ad705186-33ed-4ae6-9522-ea9f07197450",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f79cadd7-e00f-4529-bd78-6d53d85c0886",
"EffectiveDate": "2025-06-30T15:23:49.6028026-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f79c0f15-5fa0-46b1-9b2c-41fab38d0bba",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1267a975-f4a2-40ce-bcc3-ac31eae4d3a3",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f9d0a581-d2c9-4550-8977-c35a5e8ceb7b",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-30T15:23:49.6028026-07:00",
"MeasurementValueNeededDate": "2025-06-30T15:23:49.6028026-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "511f3123-3817-4596-8405-22c976235bd9",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "caec02ae-3fd9-41a9-b1a5-2e1742a45ea4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7f20bc03-cec9-41af-9d6c-95362caa267f",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T15:23:49.6028026-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4f45cfa8-0fd4-46c9-9cb5-b51f9551dc5c",
"CreateDate": "2025-06-30T15:23:49.6028026-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T15:23:49.6028026-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}