GET States?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves states for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetId |
Id of the asset |
globally unique identifier |
None. |
| take |
Number of states to retrieve. Default is all states |
integer |
None. |
| skip |
Number of states to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the states before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of states.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of State |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"StateId": "f23cc3cc-1d67-41b4-927d-202085c6be09",
"Asset": {
"AssetId": "e61f9f16-360d-4013-b5b7-23456691dfde",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d1cdee84-9bf5-4e3d-98f2-7bdef7bbd2ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6529a0e3-f156-42eb-804d-91929214b32e",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7a66b561-78e9-4929-8e5f-192069157fbd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-20T15:43:13.8114233-07:00",
"MeasurementValueNeededDate": "2026-07-20T15:43:13.8114233-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3f6ce3a-54d7-4678-9e12-5c2735a4308a",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "2e71ca51-a7f3-48a0-8f07-bb64a9aec70e",
"EffectiveDate": "2026-07-20T15:43:13.8114233-07:00",
"StatusType": {
"StatusTypeId": "8caf7ec6-cb93-4feb-887d-9cb7c0c31d96",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d1cdee84-9bf5-4e3d-98f2-7bdef7bbd2ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6529a0e3-f156-42eb-804d-91929214b32e",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2426f750-967f-4901-86e3-45de4b159a5a",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f5824b72-769b-448c-85be-98352f8ee916",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "96f45287-9c8f-4372-bfa0-4e64898f8de7",
"EffectiveDate": "2026-07-20T15:43:13.8114233-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "226eaa27-0e64-4b51-b45a-29320882363c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ff01616e-cc68-4869-836e-795a26f07fe9",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fecf17b2-1673-420c-93de-3449f87217ba",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-20T15:43:13.8114233-07:00",
"MeasurementValueNeededDate": "2026-07-20T15:43:13.8114233-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2e5101c5-7682-4305-8551-e175eb745f7f",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-07-20T15:43:13.8114233-07:00",
"StateType": {
"StateTypeId": "54a011a1-2318-4718-8afd-2f47e722d399",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d1cdee84-9bf5-4e3d-98f2-7bdef7bbd2ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6529a0e3-f156-42eb-804d-91929214b32e",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "496d19c4-ef85-4fb2-9ffa-07b9476a85cc",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b19e1ade-746f-4631-a6b3-8946a9d6d376",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 4"
},
{
"StateId": "f23cc3cc-1d67-41b4-927d-202085c6be09",
"Asset": {
"AssetId": "e61f9f16-360d-4013-b5b7-23456691dfde",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d1cdee84-9bf5-4e3d-98f2-7bdef7bbd2ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6529a0e3-f156-42eb-804d-91929214b32e",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7a66b561-78e9-4929-8e5f-192069157fbd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-20T15:43:13.8114233-07:00",
"MeasurementValueNeededDate": "2026-07-20T15:43:13.8114233-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b3f6ce3a-54d7-4678-9e12-5c2735a4308a",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "2e71ca51-a7f3-48a0-8f07-bb64a9aec70e",
"EffectiveDate": "2026-07-20T15:43:13.8114233-07:00",
"StatusType": {
"StatusTypeId": "8caf7ec6-cb93-4feb-887d-9cb7c0c31d96",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d1cdee84-9bf5-4e3d-98f2-7bdef7bbd2ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6529a0e3-f156-42eb-804d-91929214b32e",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2426f750-967f-4901-86e3-45de4b159a5a",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f5824b72-769b-448c-85be-98352f8ee916",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "96f45287-9c8f-4372-bfa0-4e64898f8de7",
"EffectiveDate": "2026-07-20T15:43:13.8114233-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "226eaa27-0e64-4b51-b45a-29320882363c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ff01616e-cc68-4869-836e-795a26f07fe9",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fecf17b2-1673-420c-93de-3449f87217ba",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-20T15:43:13.8114233-07:00",
"MeasurementValueNeededDate": "2026-07-20T15:43:13.8114233-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2e5101c5-7682-4305-8551-e175eb745f7f",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-07-20T15:43:13.8114233-07:00",
"StateType": {
"StateTypeId": "54a011a1-2318-4718-8afd-2f47e722d399",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d1cdee84-9bf5-4e3d-98f2-7bdef7bbd2ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6529a0e3-f156-42eb-804d-91929214b32e",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "496d19c4-ef85-4fb2-9ffa-07b9476a85cc",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b19e1ade-746f-4631-a6b3-8946a9d6d376",
"CreateDate": "2026-07-20T15:43:13.8114233-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-20T15:43:13.8114233-07:00",
"LastModifiedUser": "sample string 4"
}
],
"Total": 1,
"Message": "sample string 1"
}