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": "7fbc9b89-57f2-4669-acca-ad16e1b43748",
"Asset": {
"AssetId": "3da1b1b8-cd0a-485b-885a-0cd87273ad63",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "55a3af72-be5e-4992-b323-2e65bd86d494",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f41af1a-3837-4690-ba65-a35f4013788c",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9ac6b580-5849-4a09-96d2-621a79c1dee7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T04:36:00.4991697-07:00",
"MeasurementValueNeededDate": "2025-09-17T04:36:00.4991697-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "97705661-04e4-4426-95d8-ddbadf80a714",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "a46d7453-78da-497c-b35e-8a0ad1bbee15",
"EffectiveDate": "2025-09-17T04:36:00.4991697-07:00",
"StatusType": {
"StatusTypeId": "db910b74-2c60-4757-b19b-701b8a86771e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "55a3af72-be5e-4992-b323-2e65bd86d494",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f41af1a-3837-4690-ba65-a35f4013788c",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fe1bf008-a252-4035-8d87-d4b4e23c8c48",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "998ab312-2350-45fa-bce4-750a7100b3e8",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ab361cc3-748d-4586-8daf-f84f23b49ac3",
"EffectiveDate": "2025-09-17T04:36:00.4991697-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6537987b-7dbb-474c-a49f-0e75a359bd9d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "33712c3c-507f-41c7-b16c-1119901bc324",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "43306f0c-54fa-4be6-88fb-2dae331c830a",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-09-17T04:36:00.4991697-07:00",
"MeasurementValueNeededDate": "2025-09-17T04:36:00.4991697-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7b39bb3b-0950-4539-8f7e-4bf7b97d8e5f",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-09-17T04:36:00.4991697-07:00",
"StateType": {
"StateTypeId": "4fddcbe2-32d1-4872-ade6-19c014b066e8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "55a3af72-be5e-4992-b323-2e65bd86d494",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2f41af1a-3837-4690-ba65-a35f4013788c",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3a956bf6-ccac-4928-a7a8-c37753bec612",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9ae3bbef-226c-4f7b-97a9-c59ec7354913",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-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": "a1288c39-ca4f-4d30-9b98-b14eb7f7f64d",
"Asset": {
"AssetId": "2e6b3a73-e97f-490a-9c59-2e4eb2162baf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "23086caa-5d1d-46c1-bc5c-e600e4b1e2a7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a63ebd08-6013-4c1a-9d61-9b559af28bed",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "55ec06a0-0b29-434a-86fd-06e3854d9306",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-17T04:36:00.4991697-07:00",
"MeasurementValueNeededDate": "2025-09-17T04:36:00.4991697-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "91b41469-4604-4ba1-b2b8-0656a03571fc",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "27fd51c6-4cf8-4179-b6d2-79986f0bcb3b",
"EffectiveDate": "2025-09-17T04:36:00.4991697-07:00",
"StatusType": {
"StatusTypeId": "8ddc49e3-3d4d-4b95-a01b-a6b3875caf4c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "23086caa-5d1d-46c1-bc5c-e600e4b1e2a7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a63ebd08-6013-4c1a-9d61-9b559af28bed",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "34ec180c-423d-4bb4-aae9-70d9d3733005",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ab1ae684-45c6-4547-8636-c824f49962c8",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c4a7a847-08b0-43dd-afe9-af97ef2132c2",
"EffectiveDate": "2025-09-17T04:36:00.4991697-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f942a64b-67a1-4076-b155-f9bcb53bb70b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f6b6f478-adb0-497e-ad22-fc4a13875862",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4309d4f5-e785-4b71-9778-9a9fe1c36bb3",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-09-17T04:36:00.4991697-07:00",
"MeasurementValueNeededDate": "2025-09-17T04:36:00.4991697-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "97622201-b5af-42ff-953b-b28bf43501fc",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-09-17T04:36:00.4991697-07:00",
"StateType": {
"StateTypeId": "fc201082-eba5-4a03-ae00-81c43f0dde63",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "23086caa-5d1d-46c1-bc5c-e600e4b1e2a7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a63ebd08-6013-4c1a-9d61-9b559af28bed",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "68cc2fd6-23de-447a-8539-3abc19137f77",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "601cec8b-b3c8-4b88-9c6e-aafdeb1c7301",
"CreateDate": "2025-09-17T04:36:00.4991697-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-17T04:36:00.4991697-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}