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": "ab2bbb95-707c-41b4-a0e2-062089de2d4d",
"Asset": {
"AssetId": "68dca79b-08fe-4b9d-89be-f2e95d0da3a6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4ce897c1-539d-4dc2-8bfe-0af555ba6667",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e4838550-728c-4d04-b760-96aebdc28edd",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f3207afd-701f-4882-97ff-f5a6b81c617f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-24T21:36:38.8610799-07:00",
"MeasurementValueNeededDate": "2026-08-24T21:36:38.8610799-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "84de118b-3550-4f03-8745-8c4d1a80b82f",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "8cf5f626-7d2c-4ae8-9972-4a563a6f796c",
"EffectiveDate": "2026-08-24T21:36:38.8610799-07:00",
"StatusType": {
"StatusTypeId": "71023db8-72e4-4d47-8b91-b1269e6e5ec5",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4ce897c1-539d-4dc2-8bfe-0af555ba6667",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e4838550-728c-4d04-b760-96aebdc28edd",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "0b7ad322-03eb-4420-81a8-2a124770f081",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aaa471f7-d673-4e64-a047-0075cdfbfd65",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b6704190-4c54-41e2-8a17-8c1156a8262c",
"EffectiveDate": "2026-08-24T21:36:38.8610799-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c56b1608-aec5-4035-beb6-b9dda3618783",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "284a8243-e495-46e7-8135-5be4bf02704f",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "32d4a829-fd89-4cf4-90b6-2abee6165228",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-24T21:36:38.8610799-07:00",
"MeasurementValueNeededDate": "2026-08-24T21:36:38.8610799-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9b800700-2f30-47eb-8c6f-5ff7baed48a8",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-08-24T21:36:38.8610799-07:00",
"StateType": {
"StateTypeId": "ea70bc6d-4b32-4c89-b314-b083db4f28c7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4ce897c1-539d-4dc2-8bfe-0af555ba6667",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e4838550-728c-4d04-b760-96aebdc28edd",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "926f6671-7a0a-4b76-a817-76da3477c378",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e5eaf4f5-5b14-4725-8c1e-dd64849ae18f",
"CreateDate": "2026-08-24T21:36:38.8610799-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T21:36:38.8610799-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}