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": "59a86d69-107e-4851-b05c-2db2967e3716",
"Asset": {
"AssetId": "0fa5c0ea-3813-4ecb-82fa-4b01a173aa0b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9cc76303-a952-4898-8ad9-bb6d51c02c91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e2d161a9-cf0e-4aea-825c-3798250ffed5",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "1478f41c-da69-4e82-a312-35b079e6337e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-17T18:58:42.9691523-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:58:42.9691523-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c89a4481-cc73-4c0b-b31e-d1dc7bc684a6",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "1658b91f-28d9-417a-82ae-d0ec45fe7a3b",
"EffectiveDate": "2025-11-17T18:58:42.9691523-08:00",
"StatusType": {
"StatusTypeId": "d1976726-83a8-41ae-8465-dacc3d2a3be1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9cc76303-a952-4898-8ad9-bb6d51c02c91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e2d161a9-cf0e-4aea-825c-3798250ffed5",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "470624ce-48e5-4071-94b1-136a438f4cce",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dfc509ee-2e12-4678-be8c-741903657703",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "507e7bb3-6d26-4f5d-a931-022bb0673a92",
"EffectiveDate": "2025-11-17T18:58:42.9691523-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "104fd69c-9812-4565-bd4b-e4fd3e09997d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "af308e90-fda4-488a-b173-ddb431f1d0c0",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8f7e8ab5-db21-45c3-9ea2-41617a061e9e",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-17T18:58:42.9691523-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:58:42.9691523-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ed76ff60-02ac-4803-8d74-a37cb0002644",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-11-17T18:58:42.9691523-08:00",
"StateType": {
"StateTypeId": "bec9c93f-2f62-40b5-9454-3195c1f53a39",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9cc76303-a952-4898-8ad9-bb6d51c02c91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e2d161a9-cf0e-4aea-825c-3798250ffed5",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "78294925-3d2f-444a-a82d-b04abd70636a",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0983292a-cee3-47ce-bfad-7fb8a42ce9fb",
"CreateDate": "2025-11-17T18:58:42.9691523-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:58:42.9691523-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}