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": "ed2bb774-c2c1-40bc-9cc7-0ab3bdd38243",
"Asset": {
"AssetId": "61bfdf6a-938b-41fe-8a38-37d6258a918f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f1064521-beba-41cf-ab30-8c684af4cf18",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2a0e2f3e-f7a4-4124-9c3c-9d867c7b5668",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7e120fc1-04f8-4b33-9e17-b61433a709bc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-21T05:00:10.0528729-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:00:10.0528729-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "03b5e95e-8f09-4770-a561-76c18558385b",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "bcabfdfc-c026-418e-a871-62cb53ba222f",
"EffectiveDate": "2024-11-21T05:00:10.0528729-08:00",
"StatusType": {
"StatusTypeId": "e9082cf2-3c0d-4fef-8481-ea85e56a9bcf",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f1064521-beba-41cf-ab30-8c684af4cf18",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2a0e2f3e-f7a4-4124-9c3c-9d867c7b5668",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e512adb4-655f-4689-bc8d-404db2003a98",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c3ee0173-cee3-4f27-b0a2-d08303c51376",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "38386664-ae13-40f0-96ac-5fc071a92d59",
"EffectiveDate": "2024-11-21T05:00:10.0528729-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "a8442432-7ff8-4222-88ca-20a53dcbc05b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c0083a5f-bad2-4487-9ede-2150327819bc",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a516c92f-453f-444f-93b9-bba2e948fd51",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-11-21T05:00:10.0528729-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:00:10.0528729-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5c241942-92e2-4cf9-b2f1-3eaa8196cc8d",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2024-11-21T05:00:10.0528729-08:00",
"StateType": {
"StateTypeId": "79e98517-a39e-4f2a-b07d-090f1ae6ccbd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f1064521-beba-41cf-ab30-8c684af4cf18",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2a0e2f3e-f7a4-4124-9c3c-9d867c7b5668",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "85dbfb34-b109-4d65-83f9-754a2eb9f287",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0b9e6c18-04f3-4946-b287-f54eda81bf2d",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08: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": "9c815898-2b0f-48fc-b204-b47c9f5df49f",
"Asset": {
"AssetId": "ade88668-d474-443f-b206-ca38db920fab",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bb44fdd2-1900-4f09-82fe-95b7e4f82196",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93b73e55-2ba6-4c1f-88cf-39cf76377caf",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e15f6a6a-8ee5-454a-a3fc-e6711292f502",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-21T05:00:10.0528729-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:00:10.0528729-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ad2f25ad-110e-4a65-b027-b3b12dd9fb01",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "d8b12c45-6dec-4eba-99d9-b196ee0caeff",
"EffectiveDate": "2024-11-21T05:00:10.0528729-08:00",
"StatusType": {
"StatusTypeId": "bbe1c234-37ff-4760-8e39-204ff1178890",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bb44fdd2-1900-4f09-82fe-95b7e4f82196",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93b73e55-2ba6-4c1f-88cf-39cf76377caf",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fe634130-92fd-4a23-aabd-d409ca824d54",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "090f7953-11ca-4430-aa01-3f2001d6d2a0",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e84ce82d-1d41-4207-b95b-c05aa59a2a4d",
"EffectiveDate": "2024-11-21T05:00:10.0528729-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "ed949a99-d328-400b-a13c-a3cda4041a04",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bab0fd5f-68cd-4272-95a5-aa8b26f8efbc",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "07480e47-9f3e-44f5-8feb-41c7261b3628",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-11-21T05:00:10.0528729-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:00:10.0528729-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "17203987-02c4-42c7-a161-db15a4a46740",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2024-11-21T05:00:10.0528729-08:00",
"StateType": {
"StateTypeId": "3fefee2f-f944-4bde-bcd6-f63b9fa480b8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bb44fdd2-1900-4f09-82fe-95b7e4f82196",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93b73e55-2ba6-4c1f-88cf-39cf76377caf",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "56218989-f257-41b9-8b99-bc93ddf9f062",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "344d8f5e-e847-4bc2-94b5-38ab5d93bbb6",
"CreateDate": "2024-11-21T05:00:10.0528729-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-11-21T05:00:10.0528729-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}