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": "fed49551-90b3-4387-b73a-ac5124099e9f",
"Asset": {
"AssetId": "d42da8d1-d341-4b31-8883-04b81b2e4ab4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2e295022-1e78-4a38-a1dc-f1cc76a2ae57",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5e0370f6-f417-49e8-9de2-22602ad98d59",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a7e14753-5f2d-4157-b468-1e2c4b084dc1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-15T13:37:27.1226659-07:00",
"MeasurementValueNeededDate": "2025-07-15T13:37:27.1226659-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4b702c70-38f3-40ac-8b14-e4256d84d61a",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "88370565-2b70-459f-94da-abfce182bd30",
"EffectiveDate": "2025-07-15T13:37:27.1226659-07:00",
"StatusType": {
"StatusTypeId": "9d69dff8-4b11-4e6e-84ea-0e4682780737",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2e295022-1e78-4a38-a1dc-f1cc76a2ae57",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5e0370f6-f417-49e8-9de2-22602ad98d59",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "adb4f456-0f8a-4415-b107-74f6f3c04ea2",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4e4f73d7-9b17-4f88-8f7c-9cd2f7af0f54",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9f36ae21-b9df-42ae-bfb0-096323480cfb",
"EffectiveDate": "2025-07-15T13:37:27.1226659-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f2777a0e-8966-4cc5-9b03-00a2545cf889",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4ba060cc-d47b-483d-910f-1cee3826b07a",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "176b2ce2-570b-494e-9fda-0cdccc04abe0",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-15T13:37:27.1226659-07:00",
"MeasurementValueNeededDate": "2025-07-15T13:37:27.1226659-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "10be2d57-e3b7-4d63-b1af-d9fd9210bab6",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-07-15T13:37:27.1226659-07:00",
"StateType": {
"StateTypeId": "dbae962e-f7a7-4d8c-8b06-fb07004901f0",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2e295022-1e78-4a38-a1dc-f1cc76a2ae57",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5e0370f6-f417-49e8-9de2-22602ad98d59",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d1ee3a69-8d81-43c1-b4b3-89f9e6f44184",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4eccbc47-eb65-4184-ba3b-1196b4bc2536",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-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": "2aa51264-1bc9-4bef-bdbd-8ae35a8e030c",
"Asset": {
"AssetId": "65879ae6-5105-48fa-a501-447e9ecb2f4f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "38422b59-8dee-4693-9497-64cfc80bab28",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "aca1d8fd-2b81-4523-8d40-44d387e074e5",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4b8bd32a-8cce-468d-b719-702ce6abad02",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-15T13:37:27.1226659-07:00",
"MeasurementValueNeededDate": "2025-07-15T13:37:27.1226659-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2da59449-213f-425e-8739-e67fed46fe38",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "6f381b98-9e6d-4515-8897-c7c1923282b3",
"EffectiveDate": "2025-07-15T13:37:27.1226659-07:00",
"StatusType": {
"StatusTypeId": "83245d0d-1266-4ee6-a8f5-ee38abdb0e8f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "38422b59-8dee-4693-9497-64cfc80bab28",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "aca1d8fd-2b81-4523-8d40-44d387e074e5",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "92228aed-4623-4fde-a8f3-5eb4237bcd6e",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "59db87f0-e770-4df6-bac5-837244899f6a",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "17a2a841-05a0-45b8-b238-25aa2b43e3a8",
"EffectiveDate": "2025-07-15T13:37:27.1226659-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "83f0f330-a0c3-483e-abdf-3cea5e65a31d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "baa841af-38d3-42c6-bee5-a8576b5c1be3",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6fb09afb-aeb0-4155-b036-73db48e39404",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-15T13:37:27.1226659-07:00",
"MeasurementValueNeededDate": "2025-07-15T13:37:27.1226659-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1717f2ad-efb0-40f8-b706-94c72c81cc5b",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-07-15T13:37:27.1226659-07:00",
"StateType": {
"StateTypeId": "2b2602ba-dc21-440c-a434-f8eb52063eaf",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "38422b59-8dee-4693-9497-64cfc80bab28",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "aca1d8fd-2b81-4523-8d40-44d387e074e5",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "91436025-0b95-4c5e-85cb-a3ce4c242e8f",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "352c6516-10f7-4911-aad7-b072f71fd76b",
"CreateDate": "2025-07-15T13:37:27.1226659-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-15T13:37:27.1226659-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}