GET StateTypes?assetTypeId={assetTypeId}&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 state types for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
| take |
Number of state types to retrieve. Default is all state types |
integer |
None. |
| skip |
Number of state types to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the state types 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 state types.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of StateType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"StateTypeId": "4bff80f1-4f5d-496f-b7a2-f6e9b69255d3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d842d420-062c-4fe4-92a0-92f20910508e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0b0a60b4-7918-4426-8463-b7943847b827",
"CreateDate": "2026-05-11T11:43:30.9091265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:43:30.9091265-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8fb0e84d-ba0d-49c0-9dcc-012b8c31a19d",
"CreateDate": "2026-05-11T11:43:30.9091265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:43:30.9091265-07:00",
"LastModifiedUser": "sample string 6"
},
{
"StateTypeId": "4bff80f1-4f5d-496f-b7a2-f6e9b69255d3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d842d420-062c-4fe4-92a0-92f20910508e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0b0a60b4-7918-4426-8463-b7943847b827",
"CreateDate": "2026-05-11T11:43:30.9091265-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:43:30.9091265-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8fb0e84d-ba0d-49c0-9dcc-012b8c31a19d",
"CreateDate": "2026-05-11T11:43:30.9091265-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:43:30.9091265-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}