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": "f9f6deeb-8059-4d36-a522-e16c542464cd",
"Asset": {
"AssetId": "545b5756-61ef-4171-800b-36c1e0634d1c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ceb89db7-af6e-4924-8967-16ca04fe0a7f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a347af8a-3305-44da-95cb-dca718d10e35",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "11ce6f10-f785-4673-8e77-04f67bb6e0c4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T22:27:38.0072959-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:27:38.0072959-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3b2593c4-5476-415b-bc63-b812728f5c96",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "2997e164-ece5-4303-9608-73142070ef56",
"EffectiveDate": "2026-08-11T22:27:38.0072959-07:00",
"StatusType": {
"StatusTypeId": "217704af-0676-4147-8b4f-b0be48fbfdfb",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ceb89db7-af6e-4924-8967-16ca04fe0a7f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a347af8a-3305-44da-95cb-dca718d10e35",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ed162449-96f1-4761-a154-82863f68ae03",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1f6afb04-8d99-4179-b4e2-aeff7f91611e",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "88b0cd42-f01b-4927-99bf-dbb856cfb46e",
"EffectiveDate": "2026-08-11T22:27:38.0072959-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f3ece713-a711-40a2-b486-e3a43a9bf1eb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "882e17c4-2d22-4b85-b959-9660fafa2158",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "efc540eb-8626-4728-80ea-f54c452d4905",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-11T22:27:38.0072959-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:27:38.0072959-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d04ce96d-9294-4a55-85cd-86fe500245ec",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-08-11T22:27:38.0072959-07:00",
"StateType": {
"StateTypeId": "8bcf6df7-ea2d-4fd1-903a-f5a4fda1ae2f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ceb89db7-af6e-4924-8967-16ca04fe0a7f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a347af8a-3305-44da-95cb-dca718d10e35",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7e38624b-fac0-4462-a0b9-a244405ce111",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "def94f5f-92e1-4f20-a665-2e41887148cb",
"CreateDate": "2026-08-11T22:27:38.0072959-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:27:38.0072959-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}