GET States?stateId={stateId}
Retrieves a state by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| stateId |
Id of the state |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the state.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | State |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"StateId": "c7dfc741-b711-41b3-bb88-679c170d7626",
"Asset": {
"AssetId": "8a5180a8-cded-4fb0-95b6-03faf170ff43",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d4a7965c-da46-464c-8f33-15d5b79eca43",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8fb5b7b3-3c0b-4a1b-81f4-8e4c937d19d0",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ec3a4c60-8612-480a-99eb-a8d106619379",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-17T17:31:09.0269524-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:31:09.0269524-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "72596aad-d048-4270-9833-d914c2584f5f",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "561e237b-6f2a-461b-8963-9e5a195e8eaa",
"EffectiveDate": "2026-06-17T17:31:09.0269524-07:00",
"StatusType": {
"StatusTypeId": "54f59df6-1d8f-4715-9358-4a151991f396",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d4a7965c-da46-464c-8f33-15d5b79eca43",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8fb5b7b3-3c0b-4a1b-81f4-8e4c937d19d0",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2757264b-dbf2-49bb-9a26-fd069d1d1b70",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bd92cc98-21ef-4c01-a5f2-6528b75f7bb5",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e77f66f4-2446-49ae-8f4c-064f69582357",
"EffectiveDate": "2026-06-17T17:31:09.0269524-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6597d424-0838-4cea-ae06-51282e08e785",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3ab5583e-adbf-4451-aa6b-33702c5ddf8d",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2485a152-5e7a-4450-bd89-5544511b5ad3",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-17T17:31:09.0269524-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:31:09.0269524-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "cb701d54-0c94-4bfe-86e6-8c8e6ac72ca3",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-06-17T17:31:09.0269524-07:00",
"StateType": {
"StateTypeId": "74448bed-5747-46f9-8b9d-5254905393c2",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d4a7965c-da46-464c-8f33-15d5b79eca43",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8fb5b7b3-3c0b-4a1b-81f4-8e4c937d19d0",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ab328e2b-1a36-49a4-ade5-daf5fdee2e89",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "209db022-3201-43f4-9d2b-baa369425755",
"CreateDate": "2026-06-17T17:31:09.0269524-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:31:09.0269524-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}