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. |
|
| 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": "1ebd4abd-f4f2-4714-a13d-1f8c0adc454b",
"Asset": {
"AssetId": "0841aecc-5951-44d1-9a9c-810c3db04875",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "79e434b9-5db2-4852-87af-7c4126468ea0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e533019-1d64-46c1-a3b4-c9b222f006f2",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c0a1ee57-3b97-4643-b152-670bd274f231",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2023-06-04T04:35:03.894311-07:00",
"MeasurementValueNeededDate": "2023-06-04T04:35:03.894311-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4c1436e9-3cfe-4734-87bf-b1e55817aa35",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "85077ae5-75a0-436b-9cde-29fc4183f8fb",
"EffectiveDate": "2023-06-04T04:35:03.894311-07:00",
"StateType": {
"StateTypeId": "f6e34b76-de3c-49be-86ce-3126e95434b7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "79e434b9-5db2-4852-87af-7c4126468ea0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e533019-1d64-46c1-a3b4-c9b222f006f2",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "da2cf312-cd8d-490e-a46c-69121be2233d",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b941919c-525f-4ff6-8787-a4ec1c78f8b5",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "01589a48-241c-489b-b3b9-1147694e6dea",
"EffectiveDate": "2023-06-04T04:35:03.894311-07:00",
"StatusType": {
"StatusTypeId": "94b154f8-5253-4b8a-92d2-eadc451db172",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "79e434b9-5db2-4852-87af-7c4126468ea0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e533019-1d64-46c1-a3b4-c9b222f006f2",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "70e6255a-1b65-456c-8f07-26372e41ace7",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e6382df6-3bf5-4428-9a00-d3297565df11",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "efc46b0f-6fae-4f2c-95d7-3ff47415f4a4",
"EffectiveDate": "2023-06-04T04:35:03.894311-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "15ec7314-d1c7-4b83-aeee-627af5b25c2b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "68c6b785-a74b-4653-be65-8480a5c3ad66",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a87b17ea-2480-4717-9adc-15717c109c94",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2023-06-04T04:35:03.894311-07:00",
"MeasurementValueNeededDate": "2023-06-04T04:35:03.894311-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "00aa4e09-8d97-48a8-91e1-d11594d8626c",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "309d3261-ae97-4f51-9671-bafd10f248b5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2b513235-71d5-41fd-baa0-e4d157b41ef6",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2023-06-04T04:35:03.894311-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a8c06627-7dd3-4651-b40c-ed21f85ee5d7",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 5"
}
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": "4cdc09d8-3d12-4859-9f9f-dda4a53d6984",
"Asset": {
"AssetId": "7133e127-421a-490f-9bfb-0e3c54907d84",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "95f3aafc-176d-4159-b007-db3fc6961bc6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "edb439d3-f497-4678-b414-74ddf412b795",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "1b301fec-5d7c-4a86-a5ae-8f4872db2343",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2023-06-04T04:35:03.894311-07:00",
"MeasurementValueNeededDate": "2023-06-04T04:35:03.894311-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f5afdb81-5a58-4178-9b76-5fe816111ac8",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f950e6be-f1cb-4a5d-bb94-cd4141ee5583",
"EffectiveDate": "2023-06-04T04:35:03.894311-07:00",
"StateType": {
"StateTypeId": "74f35ea4-cf9a-4223-9f02-8725ca64f4ff",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "95f3aafc-176d-4159-b007-db3fc6961bc6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "edb439d3-f497-4678-b414-74ddf412b795",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7606582a-33de-4ff0-98fb-9561c2382832",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f780a472-55e7-4f10-9c41-c5f61e91f8e3",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8043289f-7445-45d4-aa24-3cc00023b35a",
"EffectiveDate": "2023-06-04T04:35:03.894311-07:00",
"StatusType": {
"StatusTypeId": "f6265177-b3b4-4da3-bd74-3b921a984ef2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "95f3aafc-176d-4159-b007-db3fc6961bc6",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "edb439d3-f497-4678-b414-74ddf412b795",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f6b6e528-d19b-490e-b79b-7802dbc2a023",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "03076abe-c741-4e4d-ad97-2c01cde4b05e",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ad027635-1dcd-4982-b11d-b2aa94a4f226",
"EffectiveDate": "2023-06-04T04:35:03.894311-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5126834d-b809-4378-ba8f-9d6c59ae04f9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e2b65579-3058-4eaf-bf8a-36962ea2648e",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1661721c-3a1f-48dc-b5f8-544025da44f0",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2023-06-04T04:35:03.894311-07:00",
"MeasurementValueNeededDate": "2023-06-04T04:35:03.894311-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a364d785-2c09-4123-abbd-0bd5f7e1c3ce",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "894ddd8b-e2f1-481d-9386-b00abf75cb68",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3731a8ef-0742-4810-b271-ad72c9d8be3f",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2023-06-04T04:35:03.894311-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "18c4e978-b214-4851-9486-fffe55448ad4",
"CreateDate": "2023-06-04T04:35:03.894311-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-06-04T04:35:03.894311-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}