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": "5df57de1-e710-4f7d-ad00-e562c28fa3ae",
"Asset": {
"AssetId": "621bfa65-6394-4672-b275-117c1e885a63",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b74da28d-41a7-438d-b18f-3ae8f2a9ffc1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "515d27f4-1d4b-4e41-bfe1-7de44e4735ed",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "460dd0cc-e915-49be-a5fb-dc9870896f81",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T02:52:01.7761276-08:00",
"MeasurementValueNeededDate": "2026-02-02T02:52:01.7761276-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3e2878e6-bbab-42a7-b649-1eef29f36c22",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "427059fc-ee1c-4db6-b726-7d21210954ad",
"EffectiveDate": "2026-02-02T02:52:01.7761276-08:00",
"StatusType": {
"StatusTypeId": "746242c7-fe8e-47b8-ad7c-12079aceab98",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b74da28d-41a7-438d-b18f-3ae8f2a9ffc1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "515d27f4-1d4b-4e41-bfe1-7de44e4735ed",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "213b0b44-fb71-42b5-9882-59d6d810d677",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a204cd4a-d97d-4700-bc2e-ecaba063ac51",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8af0167e-8437-49f5-aa42-f64d0089edef",
"EffectiveDate": "2026-02-02T02:52:01.7761276-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "11950396-dad3-434f-9054-9122a7b99fd1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e75e2772-111f-4598-a928-6eec4f20ca4e",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d8ee79df-61c8-45e9-b5df-9f92fca0106d",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T02:52:01.7761276-08:00",
"MeasurementValueNeededDate": "2026-02-02T02:52:01.7761276-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "994223b4-dd07-4729-b2d5-241a1262f42e",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-02-02T02:52:01.7761276-08:00",
"StateType": {
"StateTypeId": "3c74dce3-4a00-4768-a39e-07321eb38b2a",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b74da28d-41a7-438d-b18f-3ae8f2a9ffc1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "515d27f4-1d4b-4e41-bfe1-7de44e4735ed",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0040937d-815b-444d-a3ee-4109335569aa",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1ae58c38-8249-4a4a-a196-60fd89e5a7ca",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-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": "5c71ed98-447c-4d67-9aab-82fbfa5aed2a",
"Asset": {
"AssetId": "638e5d36-2124-4f46-a763-1791d11915f7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2171de7f-7804-48a1-b0ff-3eefb5740321",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fc1ccaa5-5ff3-424f-9794-91ecc4006d14",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "adb5a9be-721f-4437-9dec-cc4e370fc303",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T02:52:01.7761276-08:00",
"MeasurementValueNeededDate": "2026-02-02T02:52:01.7761276-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "91275f13-e1d6-4443-8409-9686bc21b64a",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "10e5795c-0f25-49fa-aa54-f4e50091c0fe",
"EffectiveDate": "2026-02-02T02:52:01.7761276-08:00",
"StatusType": {
"StatusTypeId": "d753b72f-cb26-44aa-9a90-e5622ed4da4f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2171de7f-7804-48a1-b0ff-3eefb5740321",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fc1ccaa5-5ff3-424f-9794-91ecc4006d14",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cb1beaaf-576f-49f9-be7c-ff9c1eb2a49d",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "473b4983-08cc-41fb-a9f7-ec73623d302d",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d83b1d89-dbc0-4f7a-9458-d2dd812396d2",
"EffectiveDate": "2026-02-02T02:52:01.7761276-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "a375be32-cd67-49e0-a676-d8900568d9de",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c713afc0-1e18-41a1-8431-5a5efa4d47a9",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b657db7b-9a15-4da6-b803-dbf9c567ed40",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T02:52:01.7761276-08:00",
"MeasurementValueNeededDate": "2026-02-02T02:52:01.7761276-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9094c081-a7ff-47de-8d42-2212c374ca57",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-02-02T02:52:01.7761276-08:00",
"StateType": {
"StateTypeId": "40cf3b89-35c9-405d-9818-37473df15517",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2171de7f-7804-48a1-b0ff-3eefb5740321",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fc1ccaa5-5ff3-424f-9794-91ecc4006d14",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "88da6aee-eaa4-441b-9208-f0a23deecffc",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a925e801-3225-4fc0-9dca-374c82cf4913",
"CreateDate": "2026-02-02T02:52:01.7761276-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T02:52:01.7761276-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}