Reference Guide

Related references
HTTP request headers on page 8
Request parameters on page 10
REST requests on page 12
Request parameters
The PowerStore Management REST API supports the following request parameters:
Request
parameter
Applicable request types Description
select
Collection and instance queries Specifies a comma-separated list of attributes to return in a response.
If you do not use this parameter, a query returns the id attribute only.
For more information, see Specifying the attributes to return in a query
response on page 27.
<filter
expression>
Collection queries Filters the response data against a set of criteria. Only matching
resource instances are returned. Filtering is case insensitive.
For more information, see Filtering response data on page 28.
order
Collection queries
Specifies how to sort response data. You can sort response data in
ascending or descending order based on one of the following:
● The attributes of the queried resource type.
● The attributes of a resource type that is embedded in the primary
resource type or related through a foreign key.
● A computed attribute.
For more information, see Sorting response data on page 30.
async
Most non-GET requests Setting this parameter to true (?async=true) runs the request in
the background. Most active management requests (ones that attempt
to change the configuration) support this option. By default, requests
are run synchronously.
For more information, see Working with asynchronous requests on
page 41.
To use request parameters, append the parameters to the request URI. The first request parameter appended to the URI begins
with a ? character. Subsequent request parameters appended to the URI begin with a & character. You can combine request
parameters and can use them in any order.
Examples
Using the select request parameter
The following request uses a select request parameter to return the values for the id, severity, and description
attributes for all alert instances.
Request
GET https://1.2.3.4/api/rest/alert?select=id,severity,description_l10n
Response
[
{
"id":"014f999e-96d8-4f85-853c-c6a0e2569088",
"severity":"Minor",
"description_l10n":"Cluster license installation failed due to Fail to
obtain license file. The trial period will expire on 2019-11-27 18:47:26.985,
10 REST request components