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": "db98c1ef-85ea-4471-af7c-de54c8cb5221",
"Asset": {
"AssetId": "896cb0e1-e0f1-4d21-ae1c-a9add6cc554f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ced792cc-e975-4d5f-97d1-8df1ed8a08ad",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f084b2f3-b85c-4a9b-9f50-fa64f8efcc80",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "cf4778bd-0f1c-4b9f-8cdd-de618b0a4f82",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T17:16:22.3605786-08:00",
"MeasurementValueNeededDate": "2025-11-04T17:16:22.3605786-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4d15415d-db48-4c46-aa40-cfc7ed773df6",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "8aae3feb-07b5-4928-bafe-a53ace6d1328",
"EffectiveDate": "2025-11-04T17:16:22.3605786-08:00",
"StatusType": {
"StatusTypeId": "97a174fc-e734-49f1-934e-e98c42a78be2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ced792cc-e975-4d5f-97d1-8df1ed8a08ad",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f084b2f3-b85c-4a9b-9f50-fa64f8efcc80",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "02da6a9d-d96f-4db2-8327-cf719106c100",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "37e75921-9171-44ae-99d4-af5a4f67b32d",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8fc76363-d281-4058-b3e6-ee66d543e9bb",
"EffectiveDate": "2025-11-04T17:16:22.3605786-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "475baa9f-bdc3-4607-bf10-338dd0d92757",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0f800a02-bfc3-481a-af2a-f23fd61e8a24",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3d3d4b65-b9d4-486d-8b77-45e0eaecd1cb",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T17:16:22.3605786-08:00",
"MeasurementValueNeededDate": "2025-11-04T17:16:22.3605786-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4b94ae4e-c493-467d-bbe1-e76dddf23506",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-11-04T17:16:22.3605786-08:00",
"StateType": {
"StateTypeId": "bbd6e6cb-fc0b-41e4-b9e8-36f2032e3922",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ced792cc-e975-4d5f-97d1-8df1ed8a08ad",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f084b2f3-b85c-4a9b-9f50-fa64f8efcc80",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0fe24c13-0ec0-477a-b9d4-691f011d825e",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0b5003c6-0b5b-48ad-9beb-d6035c5f4b55",
"CreateDate": "2025-11-04T17:16:22.3605786-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T17:16:22.3605786-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}