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": "f56f05a7-5c91-4b31-9325-be5bbf8cabb5",
"Asset": {
"AssetId": "51143645-202e-47de-8340-1ff2ce25495e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "33d5bbaf-bc80-44c3-9823-65fe17d613aa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3c6f65c2-75c6-457b-abc4-2f795cec6ce0",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f758bd31-18d5-4ecf-88e9-6d019eb24eca",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:20:24.585463-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:20:24.585463-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1a2780a5-8d15-4943-8e8d-a3db115744d7",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "81109176-bc23-487d-a185-484fada2f7ec",
"EffectiveDate": "2024-12-21T19:20:24.585463-08:00",
"StatusType": {
"StatusTypeId": "c1182f1c-8970-47d0-b9bb-24532eb7eaf0",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "33d5bbaf-bc80-44c3-9823-65fe17d613aa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3c6f65c2-75c6-457b-abc4-2f795cec6ce0",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9d4f5159-0fb5-4278-8c59-65ae4e660d61",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "82351506-5a0f-4644-aa6f-739313a3f22f",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "bf0c5528-21df-4a78-bc1e-418db0fc4b68",
"EffectiveDate": "2024-12-21T19:20:24.585463-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "19fb43c2-46f9-494c-a353-7aea1fa6be8e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7ceda05c-ab67-4705-b95f-15f8074abc8a",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a9b4d7bc-f65d-496e-bc35-63ff023e5fa8",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-12-21T19:20:24.585463-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:20:24.585463-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "aa295e23-a056-41d6-8b3a-aebd659d9728",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2024-12-21T19:20:24.585463-08:00",
"StateType": {
"StateTypeId": "4aea1c7d-b8b3-4c37-882a-d4df21f24040",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "33d5bbaf-bc80-44c3-9823-65fe17d613aa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3c6f65c2-75c6-457b-abc4-2f795cec6ce0",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "5a8ac34c-3877-4ff7-b675-4e1d1cc86b49",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "43930ffd-7f15-44b5-ab75-21d6ee8fa350",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-12-21T19:20:24.585463-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": "cc1187e5-ce12-4d79-95b3-dec0cf4c6a73",
"Asset": {
"AssetId": "11fc67c6-c053-4205-bd45-25b885dd5695",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "eb818840-8a28-4838-bd79-67aa315f03e0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "42f6a0d3-0e00-43e3-a246-d6e1f8a41ff7",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "bfc45a64-6251-4b16-ba5c-6928143b3a7a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:20:24.585463-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:20:24.585463-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4ca596d7-38ec-477e-953b-2033c8daaee8",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "4a9c4562-7f72-4817-bb06-cc1f3e338133",
"EffectiveDate": "2024-12-21T19:20:24.585463-08:00",
"StatusType": {
"StatusTypeId": "0b75ddc9-2d81-4593-b00e-79757b559942",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "eb818840-8a28-4838-bd79-67aa315f03e0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "42f6a0d3-0e00-43e3-a246-d6e1f8a41ff7",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b0b59bc2-fed4-424f-9a2d-8a9d85c8cffa",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c459c950-339b-48f9-a047-308f84c510c9",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "656bda79-0f4b-451a-8846-2a55ff1d8982",
"EffectiveDate": "2024-12-21T19:20:24.585463-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d6653fe9-a238-4854-b8ff-6f50b777e3ce",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2fd564df-da91-4c8b-8f85-e052defed398",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b8a00289-87aa-4278-addc-60b15eff6d53",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-12-21T19:20:24.585463-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:20:24.585463-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e3d0366b-b63f-4427-96ca-c444cdbddffc",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2024-12-21T19:20:24.585463-08:00",
"StateType": {
"StateTypeId": "21afb7ea-7c92-44f8-b423-86fd3231fca2",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "eb818840-8a28-4838-bd79-67aa315f03e0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "42f6a0d3-0e00-43e3-a246-d6e1f8a41ff7",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "cec650ac-994b-428f-a127-a86f7947fe95",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "69b902de-cc6d-45df-8026-624fdf4448b9",
"CreateDate": "2024-12-21T19:20:24.585463-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-12-21T19:20:24.585463-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}