PUT States
Updates the given state.
Request Information
URI Parameters
None.
Body Parameters
The state to update
State| Name | Description | Type | Additional information |
|---|---|---|---|
| StateId | globally unique identifier |
None. |
|
| Asset | Asset |
None. |
|
| EffectiveDate | date |
None. |
|
| StateType | StateType |
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:
{
"StateId": "3947ec05-77aa-4bbb-9852-7622df99d468",
"Asset": {
"AssetId": "8acf9624-48d6-46d7-baa3-7a22f3bd120c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1fe4b511-c49b-43c4-8988-ebb64c2f6ae0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d35a8214-9f31-44a4-93be-ef5a9c7a864d",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d7527e6e-647f-49b9-84ac-e00ccdd92f58",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2023-06-04T04:19:49.1828674-07:00",
"MeasurementValueNeededDate": "2023-06-04T04:19:49.1828674-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "89680ca7-8208-41c3-9b6a-592aa2a3eb78",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "b11ac708-1bf2-4c22-91a5-468d30143002",
"EffectiveDate": "2023-06-04T04:19:49.1828674-07:00",
"StatusType": {
"StatusTypeId": "d656b1b6-fed0-4657-ab82-97cc5a963bdf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1fe4b511-c49b-43c4-8988-ebb64c2f6ae0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d35a8214-9f31-44a4-93be-ef5a9c7a864d",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "455968cc-c7d7-498d-b72d-193a2f012550",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e6c157e4-d027-42a2-b97c-347795fdcb83",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3de32281-c586-4b5e-9e82-ba9a03fcedd5",
"EffectiveDate": "2023-06-04T04:19:49.1828674-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "82fba751-c76a-4119-bd56-9c256ef5c972",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8ab5ff16-de1d-483d-b25c-76d3cbe9e1fc",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1ed5b2dc-38ef-4820-b748-63b696961931",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2023-06-04T04:19:49.1828674-07:00",
"MeasurementValueNeededDate": "2023-06-04T04:19:49.1828674-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "12d08ac6-b1e1-4141-8a12-cae16ecb8601",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2023-06-04T04:19:49.1828674-07:00",
"StateType": {
"StateTypeId": "9a746f1a-de80-46e7-a012-a7b92bf9d0f8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1fe4b511-c49b-43c4-8988-ebb64c2f6ae0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d35a8214-9f31-44a4-93be-ef5a9c7a864d",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4950c23f-613c-4ca1-ad7c-74e0acc9e7cc",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "645cd7f1-1782-4c75-a08b-9ef0f6020a11",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 4"
}
Response Information
Resource Description
On success, the updated state.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | State |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"StateId": "28436470-47e2-458a-bb41-a6d860766d7c",
"Asset": {
"AssetId": "c43b8254-0996-4f63-aab9-f632aa38f9af",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5116ede8-d0e8-49dc-8022-3bc25ef55b61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47f04d48-0948-4815-be3c-73cda9eab362",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d91aa6c9-b2d1-4f49-a632-64b164964afb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2023-06-04T04:19:49.1828674-07:00",
"MeasurementValueNeededDate": "2023-06-04T04:19:49.1828674-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "13295570-9ff7-44c5-aa49-9b3309d4a5a1",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "28761656-4859-4973-860e-98a4fc29ea11",
"EffectiveDate": "2023-06-04T04:19:49.1828674-07:00",
"StatusType": {
"StatusTypeId": "4d6a319e-7cd9-4e13-a87b-bf61a2c377a6",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5116ede8-d0e8-49dc-8022-3bc25ef55b61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47f04d48-0948-4815-be3c-73cda9eab362",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a6e14695-c915-45ab-a9af-ec97baa6753f",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d0e14495-1f0b-4704-928a-d6a06fdc3e9d",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9fffbaab-863a-4e2b-a55b-532478945421",
"EffectiveDate": "2023-06-04T04:19:49.1828674-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "93f461f7-7e4c-4e22-b427-91e3a4a3430c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3dc41ff8-e5e4-4413-987c-6b518e36ec32",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "29d28b05-fedf-4ce4-9e71-071aaac724d4",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2023-06-04T04:19:49.1828674-07:00",
"MeasurementValueNeededDate": "2023-06-04T04:19:49.1828674-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4eaf2910-8d6c-40cf-970a-a3ec3f97fd77",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2023-06-04T04:19:49.1828674-07:00",
"StateType": {
"StateTypeId": "86eb0e9d-1a33-4075-a3c3-bb492ff791fd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5116ede8-d0e8-49dc-8022-3bc25ef55b61",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "47f04d48-0948-4815-be3c-73cda9eab362",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "30cfbeae-585c-4dc6-9cd7-194aacd5efb5",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5da6640f-89a0-43f2-9ff6-5521556b1b80",
"CreateDate": "2023-06-04T04:19:49.1828674-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2023-06-04T04:19:49.1828674-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}