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	Type	Additional information
Data	Collection of StateType	None.
Total	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "StateTypeId": "112224f0-3bfe-42d7-8193-61ff7d5969f4",
      "Name": "sample string 1",
      "IsOperational": true,
      "AssetType": {
        "AssetTypeId": "1de8cd6b-083c-4909-9126-9a48011d8818",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "33804b49-a1f1-4543-aff5-62da10d9d15b",
        "CreateDate": "2023-06-04T04:33:56.3074529-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2023-06-04T04:33:56.3074529-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "SourceSystemId": "sample string 3",
      "CompanyId": "0680fd6d-d527-4e99-9a98-9c480c4b0c99",
      "CreateDate": "2023-06-04T04:33:56.3074529-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2023-06-04T04:33:56.3074529-07:00",
      "LastModifiedUser": "sample string 6"
    },
    {
      "StateTypeId": "112224f0-3bfe-42d7-8193-61ff7d5969f4",
      "Name": "sample string 1",
      "IsOperational": true,
      "AssetType": {
        "AssetTypeId": "1de8cd6b-083c-4909-9126-9a48011d8818",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "33804b49-a1f1-4543-aff5-62da10d9d15b",
        "CreateDate": "2023-06-04T04:33:56.3074529-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2023-06-04T04:33:56.3074529-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "SourceSystemId": "sample string 3",
      "CompanyId": "0680fd6d-d527-4e99-9a98-9c480c4b0c99",
      "CreateDate": "2023-06-04T04:33:56.3074529-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2023-06-04T04:33:56.3074529-07:00",
      "LastModifiedUser": "sample string 6"
    }
  ],
  "Total": 1,
  "Message": "sample string 1"
}