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": "4dcd1011-d266-4a3c-a384-80ae64679fa7",
"Asset": {
"AssetId": "65686258-edf7-4667-a8da-bb3c700e67cc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b99fde57-e4e6-4638-9d4e-032e29a6e4c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b8395082-fbec-4674-bea3-c49fced3f341",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5ec6da1f-70fc-42c8-9b4c-c2bee5f543a3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-01T20:28:15.0558303-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:28:15.0558303-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b2691459-1632-4bf7-9363-f24e05cce5f4",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "c442a281-06fa-4a69-ab0b-08c85ae5045a",
"EffectiveDate": "2026-06-01T20:28:15.0558303-07:00",
"StatusType": {
"StatusTypeId": "1c906e06-6a1a-44bd-9656-fc144936cb04",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b99fde57-e4e6-4638-9d4e-032e29a6e4c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b8395082-fbec-4674-bea3-c49fced3f341",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "73a86f25-822f-4265-b949-8b9f2c135644",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fc242aa3-a3b8-4979-955d-15d63bb46df4",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1f85763b-7c2d-4266-ab30-0c8b26c83ae7",
"EffectiveDate": "2026-06-01T20:28:15.0558303-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4bbdff3b-c00d-45ff-a16c-51f05a86a7cd",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "78f21ca6-9787-4872-a319-95953c17a9bc",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fbe14902-34db-4d88-9dca-6eb982fea2df",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-01T20:28:15.0558303-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:28:15.0558303-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0e46418f-0bfe-4f04-a9e9-9abef5bdd0de",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-06-01T20:28:15.0558303-07:00",
"StateType": {
"StateTypeId": "8232b3cc-6945-4ede-8d39-a811354da644",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b99fde57-e4e6-4638-9d4e-032e29a6e4c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b8395082-fbec-4674-bea3-c49fced3f341",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ee3ac0c2-771b-4e03-939a-4204ba977ca1",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9d07eff4-d283-4bc4-b440-cd5261988a8b",
"CreateDate": "2026-06-01T20:28:15.0558303-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:28:15.0558303-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}