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": "66879738-22c9-424c-8d1e-9402145ea4b1",
"Asset": {
"AssetId": "d22fb304-8f10-40f0-909e-cb6b21e251b6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "87c68c76-8db1-410c-95da-4393f5798748",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc00b4cc-ed6b-4d52-8066-380ac424a05d",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e6398d8f-e36c-465a-a097-9a8419f4d64e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T01:57:48.1931525-07:00",
"MeasurementValueNeededDate": "2026-04-27T01:57:48.1931525-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "76260274-9477-47e4-bf3b-0a658e749dab",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d725b75a-323a-4e17-8302-24f326f11871",
"EffectiveDate": "2026-04-27T01:57:48.1931525-07:00",
"StateType": {
"StateTypeId": "c5ce4d98-b7f3-4789-85fa-0beb51576b5a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "87c68c76-8db1-410c-95da-4393f5798748",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc00b4cc-ed6b-4d52-8066-380ac424a05d",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c86a230c-1561-496e-aa4a-d0468bfc084b",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7daa442e-5983-41fe-ac1b-702bf49d8f26",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "cae0837e-3faf-4251-bc5a-be031679d4b1",
"EffectiveDate": "2026-04-27T01:57:48.1931525-07:00",
"StatusType": {
"StatusTypeId": "bde86358-de81-4b70-ad9d-a0b8d67d3285",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "87c68c76-8db1-410c-95da-4393f5798748",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bc00b4cc-ed6b-4d52-8066-380ac424a05d",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1e5f8614-4707-47a3-958d-e9103a6669ab",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "08869a16-7ae9-44c6-9985-c1eb9648c613",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8a5c8d94-3645-423d-b78e-218f7464f350",
"EffectiveDate": "2026-04-27T01:57:48.1931525-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "9db73e1a-9356-4669-8de8-9442c022020a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "44febca1-7e99-4773-bfb1-b2fb5342c8be",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a926bd76-e53c-4ae6-9023-3318553748ba",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-27T01:57:48.1931525-07:00",
"MeasurementValueNeededDate": "2026-04-27T01:57:48.1931525-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "56f3d304-4c28-4be3-8a30-6c9bc35a17c9",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "2a8dab34-f878-4e64-970f-02138bfdd0cd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7b0eea25-1842-412e-8c78-034905d255db",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-27T01:57:48.1931525-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0a58ffd0-fa50-477a-9256-8130d5483c0f",
"CreateDate": "2026-04-27T01:57:48.1931525-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T01:57:48.1931525-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": "42bf210e-24fa-4405-8169-c8eaf45e1912",
"Asset": {
"AssetId": "5462e3ce-37ad-4e6b-8dfc-e7500e21dd16",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4644ba7b-029e-45b7-b255-8545f8b372b2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "54421293-ea35-4ee5-b641-89e98e9d4af4",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9c1af479-7ab1-49c6-b718-acad22a19c37",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T01:57:48.2087658-07:00",
"MeasurementValueNeededDate": "2026-04-27T01:57:48.2087658-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a6abe3ca-3930-4c4e-8f67-c120e4742069",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "791e871f-06bb-4445-ad29-a290b1d34cd5",
"EffectiveDate": "2026-04-27T01:57:48.2087658-07:00",
"StateType": {
"StateTypeId": "7c18c190-fc3e-438a-8398-b0327d2e6773",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4644ba7b-029e-45b7-b255-8545f8b372b2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "54421293-ea35-4ee5-b641-89e98e9d4af4",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "771d1989-ce97-41bf-a101-6719d5ebba0d",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2a8ad2ce-8209-487e-ac8f-f30513f9e6b4",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "11492f49-04ac-412f-afbc-23dea21719e1",
"EffectiveDate": "2026-04-27T01:57:48.2087658-07:00",
"StatusType": {
"StatusTypeId": "1cde0e12-4f0d-4032-a579-da0602d55eef",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4644ba7b-029e-45b7-b255-8545f8b372b2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "54421293-ea35-4ee5-b641-89e98e9d4af4",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a65bfff6-f9e5-405f-b0e5-c12e2dee454e",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6dc13f85-e19d-466a-80fa-abf63da066e2",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "81a16e47-a266-427f-9f87-059c73628151",
"EffectiveDate": "2026-04-27T01:57:48.2087658-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "677b4839-9778-4ac9-b370-fb2cebdd5fef",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5f8d8500-9026-4f19-b120-51c1cdd2fa2e",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a279ec75-4fff-4f81-a16e-065af7cfa7e7",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-27T01:57:48.2087658-07:00",
"MeasurementValueNeededDate": "2026-04-27T01:57:48.2087658-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b9c78387-fc8b-4c1a-84b1-f6706e8ba148",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "d0de080f-317e-4137-8e94-bdc9d4b33fad",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dffe4c68-3d23-4d55-b27e-a6dd15d7cb4c",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-27T01:57:48.2087658-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f5c313cf-db99-4ae6-8fd0-d76901a256d5",
"CreateDate": "2026-04-27T01:57:48.2087658-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T01:57:48.2087658-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}