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": "7d8e6b0a-2619-4190-93c7-a237eb6097b9",
"Asset": {
"AssetId": "6938e0a7-418d-4400-94b5-000d1332004a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "566f6696-8649-4395-9cc0-5c0922ce6550",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc6107aa-44ec-46b4-aa6f-afbfbe241cbc",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "37744094-fcc2-4779-a7e3-5d0735285465",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-13T23:59:25.3128048-07:00",
"MeasurementValueNeededDate": "2026-05-13T23:59:25.3128048-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b0b7830c-98bc-451d-b376-8754ef69ecde",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e8f95b41-62a4-41fd-933b-3f35a2262836",
"EffectiveDate": "2026-05-13T23:59:25.3128048-07:00",
"StateType": {
"StateTypeId": "e9422188-79d6-4e2f-825b-804f55e1fb07",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "566f6696-8649-4395-9cc0-5c0922ce6550",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc6107aa-44ec-46b4-aa6f-afbfbe241cbc",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "39bf401e-b5a1-4356-b83e-dc5b18013ba9",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a21594a9-0a9a-443c-b2ee-7137c1f1cdc5",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9817e487-19ac-4fe7-974b-3b91c116fbf3",
"EffectiveDate": "2026-05-13T23:59:25.3128048-07:00",
"StatusType": {
"StatusTypeId": "7bcc1b7f-ffbb-4373-864a-b5ab6135f7c9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "566f6696-8649-4395-9cc0-5c0922ce6550",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc6107aa-44ec-46b4-aa6f-afbfbe241cbc",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e7bc7e6b-e968-4e72-b45d-ae801d06661d",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d2c8f42a-06eb-4473-a723-df86845f2084",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "7a29369a-4f13-48b8-86f8-eabad6aeb5c0",
"EffectiveDate": "2026-05-13T23:59:25.3128048-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0898295a-9d36-4580-9fee-580ea383fe22",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7f334d2c-0955-4e0c-b5af-f97fd723edb2",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "026d9b98-f6f9-4c3e-b84f-cbec8100b128",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-13T23:59:25.3128048-07:00",
"MeasurementValueNeededDate": "2026-05-13T23:59:25.3128048-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a51ca58e-0edc-405b-89dd-b60fc916913e",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c1d9f688-8598-4eb8-81ed-bdea1edf630f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7dae59a2-94f7-446f-bd04-bf4769a08688",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-13T23:59:25.3128048-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8549b7bb-7064-49a1-93a8-07dfb9a75ae9",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-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": "5c1e39ad-62cb-4ee6-81da-b25f47dbf531",
"Asset": {
"AssetId": "8e825f85-e6ea-4696-9225-206f728f53ce",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6be9dc75-7b9f-4442-95a7-6b84230560ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "85d10db1-ede6-4450-a5c6-600f57d59ed3",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ce12e361-7e5a-4430-af43-f9834bc937c6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-13T23:59:25.3128048-07:00",
"MeasurementValueNeededDate": "2026-05-13T23:59:25.3128048-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9ebf860d-0159-4d17-a1a8-445242e57d82",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4cc85162-ef2f-4844-a7c6-f820ad9f76a9",
"EffectiveDate": "2026-05-13T23:59:25.3128048-07:00",
"StateType": {
"StateTypeId": "e4a41b4e-c825-4fea-8d1f-c34ed7a937c7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6be9dc75-7b9f-4442-95a7-6b84230560ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "85d10db1-ede6-4450-a5c6-600f57d59ed3",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8281cbe2-f83c-4c04-a5fe-58c3d7b38c8f",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "15e9c5d2-dd89-4a78-9e32-09ad1845b0b7",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c75f1ccc-649f-431b-9646-fadcf221072e",
"EffectiveDate": "2026-05-13T23:59:25.3128048-07:00",
"StatusType": {
"StatusTypeId": "318fa8b4-49ec-4516-9558-e81fd7c01a2c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6be9dc75-7b9f-4442-95a7-6b84230560ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "85d10db1-ede6-4450-a5c6-600f57d59ed3",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3757a6db-bcc2-47e4-9c00-85d33336ba04",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8d0c060a-e019-4e5c-a297-b72e177918b6",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3ac814aa-10d7-4d2a-835f-c568a6e3740f",
"EffectiveDate": "2026-05-13T23:59:25.3128048-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "686b05c4-5a34-4fc3-a400-0db4dc256103",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1626ef1b-1504-47c8-83fa-a08061863330",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9469d6cb-111c-4a5a-adb7-9f2801304d6f",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-13T23:59:25.3128048-07:00",
"MeasurementValueNeededDate": "2026-05-13T23:59:25.3128048-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a37f1abb-9afa-4df5-aa77-e86895ea23a7",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4a731335-518f-4ed9-8857-dfc35892f663",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4ff5f2c4-0b83-4fb1-81b9-725ab4a70789",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-13T23:59:25.3128048-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "86c74fac-f423-41da-94ce-c2e8ac5397c3",
"CreateDate": "2026-05-13T23:59:25.3128048-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-13T23:59:25.3128048-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}