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": "7d38f389-221b-4055-8065-071d2b25de33",
"Asset": {
"AssetId": "2dde9b16-d353-4910-8595-1c9349c22a96",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f7a0f0cf-5b5d-4941-8234-97e2aa4e84f0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6756fa52-f6e5-4061-8170-bbbfbf19178d",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "010f16d8-c4fd-4160-a4fd-0f9b4afc251d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T15:06:10.8794778-08:00",
"MeasurementValueNeededDate": "2025-11-04T15:06:10.8794778-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1ffe0c47-3151-4df1-82a2-9c2ec3565c5c",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "32f11c28-40b7-4936-a024-4138a45d7974",
"EffectiveDate": "2025-11-04T15:06:10.8794778-08:00",
"StatusType": {
"StatusTypeId": "844e36a4-8d9c-4e91-96ff-6691c2247dcb",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f7a0f0cf-5b5d-4941-8234-97e2aa4e84f0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6756fa52-f6e5-4061-8170-bbbfbf19178d",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ee382c5a-fe06-4a6c-aa74-8ab01eb86dcc",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "26b29acf-b7a4-413b-947d-1d316bae8ec3",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5203b03b-2988-43eb-a9df-db02194bdc70",
"EffectiveDate": "2025-11-04T15:06:10.8794778-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "6aa882d5-7245-41b8-9aca-ece81af8aa72",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2ecbb901-84d6-4105-a315-db13610fba82",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "16c3f32b-e05a-4c1d-955e-7cf0f4cb78db",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T15:06:10.8794778-08:00",
"MeasurementValueNeededDate": "2025-11-04T15:06:10.8794778-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1b226ba8-2ea6-4609-a417-d39a846e8130",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-11-04T15:06:10.8794778-08:00",
"StateType": {
"StateTypeId": "cc03c8eb-4bda-436f-a750-aa2d01367c84",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f7a0f0cf-5b5d-4941-8234-97e2aa4e84f0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6756fa52-f6e5-4061-8170-bbbfbf19178d",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7ea61c96-331a-47a4-81ad-5eb4195bd40e",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2706e79c-9b5e-49c9-8cd3-9231b3f8b59b",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-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": "5a56fa79-d8fe-42b0-aec0-78a43378372c",
"Asset": {
"AssetId": "d9111d7e-eb14-4f60-ad95-556ca1bb0212",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "459d3ed3-e563-4c01-87a2-dd0b53750121",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fc05bea6-83a9-4c5a-ad84-0ca9d455a9a2",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9f58b72a-3abb-4b7e-b687-bf7995f12eff",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T15:06:10.8794778-08:00",
"MeasurementValueNeededDate": "2025-11-04T15:06:10.8794778-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2db2a883-b5f7-4cc9-a951-739dc8a9a009",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "88e6db8c-e995-4bfa-b428-ceb023022908",
"EffectiveDate": "2025-11-04T15:06:10.8794778-08:00",
"StatusType": {
"StatusTypeId": "98d80948-90ea-4cf5-bc6f-b8c7481008e7",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "459d3ed3-e563-4c01-87a2-dd0b53750121",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fc05bea6-83a9-4c5a-ad84-0ca9d455a9a2",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6e9de3ac-5a01-4fdc-8181-8b4b1c28d7f0",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7325843e-4fe5-4ef9-b5bf-e6fe1d56fc66",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "110b575a-da05-454f-b2cb-9e8bf31aae7d",
"EffectiveDate": "2025-11-04T15:06:10.8794778-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "9f126a11-a44e-46ee-9d47-8c5175d898d0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "07d1fc16-ce27-42fa-82cd-cdeebaf96335",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "65e39722-a9e5-47e7-8cab-bc9157baf72a",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T15:06:10.8794778-08:00",
"MeasurementValueNeededDate": "2025-11-04T15:06:10.8794778-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4b1e6dd0-1b54-451b-aad0-274f18103d70",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-11-04T15:06:10.8794778-08:00",
"StateType": {
"StateTypeId": "b346f479-bf57-4685-bb38-e5df875cf7c8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "459d3ed3-e563-4c01-87a2-dd0b53750121",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fc05bea6-83a9-4c5a-ad84-0ca9d455a9a2",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "de9a9ade-e156-454b-9e45-ca7df97e477a",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "260614cb-8807-4fee-a82c-570d054b14b1",
"CreateDate": "2025-11-04T15:06:10.8794778-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T15:06:10.8794778-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}