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": "b1176e9c-9ae5-45f7-9aa7-813962cb1ec6",
"Asset": {
"AssetId": "83ada493-f861-43f7-9c66-992edf8b63fd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4947f4be-d156-4332-8c93-eb0cc10f59c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34ec7c1f-4c9d-452e-85b3-0432f776976b",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "791bbe12-95cb-46ed-bb76-0ab415a7c287",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-19T04:53:51.3491779-07:00",
"MeasurementValueNeededDate": "2025-07-19T04:53:51.3491779-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "772d25fb-eea5-420d-830c-fcdd5a998b0a",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "78c1c465-a4a9-4a6a-8ee8-8ab365c29d19",
"EffectiveDate": "2025-07-19T04:53:51.3491779-07:00",
"StatusType": {
"StatusTypeId": "499c9e84-52c6-4dc3-a538-bd31e392acd4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4947f4be-d156-4332-8c93-eb0cc10f59c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34ec7c1f-4c9d-452e-85b3-0432f776976b",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f53d82c7-139e-4476-b193-5f94381f5cfb",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "33129e9c-7d58-4a57-a712-256810f5c7c2",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "51f41881-8f3d-4999-95b1-b6f37770b5ea",
"EffectiveDate": "2025-07-19T04:53:51.3491779-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "64212227-8fc9-4347-9665-91c98f785047",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4bcd4fd3-79bc-4363-8920-450fbcb6becd",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "75da0502-9bf1-4e6a-9acd-09a86467a130",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-19T04:53:51.3491779-07:00",
"MeasurementValueNeededDate": "2025-07-19T04:53:51.3491779-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "92c35cc9-88c5-4869-9705-9d62820ddd36",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-07-19T04:53:51.3491779-07:00",
"StateType": {
"StateTypeId": "f2c05b90-cddd-494c-b3ea-7d1cfc70dae5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4947f4be-d156-4332-8c93-eb0cc10f59c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34ec7c1f-4c9d-452e-85b3-0432f776976b",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d4db7fab-6072-414d-b045-6633dd3cc6b1",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "52684686-2d6b-408a-b3ef-5136681d55ba",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 4"
},
{
"StateId": "b1176e9c-9ae5-45f7-9aa7-813962cb1ec6",
"Asset": {
"AssetId": "83ada493-f861-43f7-9c66-992edf8b63fd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4947f4be-d156-4332-8c93-eb0cc10f59c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34ec7c1f-4c9d-452e-85b3-0432f776976b",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "791bbe12-95cb-46ed-bb76-0ab415a7c287",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-07-19T04:53:51.3491779-07:00",
"MeasurementValueNeededDate": "2025-07-19T04:53:51.3491779-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "772d25fb-eea5-420d-830c-fcdd5a998b0a",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "78c1c465-a4a9-4a6a-8ee8-8ab365c29d19",
"EffectiveDate": "2025-07-19T04:53:51.3491779-07:00",
"StatusType": {
"StatusTypeId": "499c9e84-52c6-4dc3-a538-bd31e392acd4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4947f4be-d156-4332-8c93-eb0cc10f59c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34ec7c1f-4c9d-452e-85b3-0432f776976b",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f53d82c7-139e-4476-b193-5f94381f5cfb",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "33129e9c-7d58-4a57-a712-256810f5c7c2",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "51f41881-8f3d-4999-95b1-b6f37770b5ea",
"EffectiveDate": "2025-07-19T04:53:51.3491779-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "64212227-8fc9-4347-9665-91c98f785047",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4bcd4fd3-79bc-4363-8920-450fbcb6becd",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "75da0502-9bf1-4e6a-9acd-09a86467a130",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-07-19T04:53:51.3491779-07:00",
"MeasurementValueNeededDate": "2025-07-19T04:53:51.3491779-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "92c35cc9-88c5-4869-9705-9d62820ddd36",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-07-19T04:53:51.3491779-07:00",
"StateType": {
"StateTypeId": "f2c05b90-cddd-494c-b3ea-7d1cfc70dae5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4947f4be-d156-4332-8c93-eb0cc10f59c8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34ec7c1f-4c9d-452e-85b3-0432f776976b",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d4db7fab-6072-414d-b045-6633dd3cc6b1",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "52684686-2d6b-408a-b3ef-5136681d55ba",
"CreateDate": "2025-07-19T04:53:51.3491779-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-07-19T04:53:51.3491779-07:00",
"LastModifiedUser": "sample string 4"
}
],
"Total": 1,
"Message": "sample string 1"
}