Additional Resources
......................................................................................................................
5
1 Overview
.....................................................................................................................................
6
The PowerStore Management REST API
..........................................................................................................................
6
Resource-oriented architecture and REST
........................................................................................................................
6
JSON data exchange format
................................................................................................................................................
7
2 REST request components
............................................................................................................
8
HTTP request headers
..........................................................................................................................................................
8
URI patterns
...........................................................................................................................................................................
8
Request parameters
..............................................................................................................................................................
9
REST requests
......................................................................................................................................................................
12
3 REST responses
..........................................................................................................................
13
Response components
........................................................................................................................................................
13
HTTP response headers
......................................................................................................................................................
13
HTTP status codes
..............................................................................................................................................................
13
JSON collection response body
.........................................................................................................................................
15
JSON instance response body
...........................................................................................................................................
15
JSON create response body
...............................................................................................................................................
16
Response with no body
.......................................................................................................................................................
16
JSON job response body
.....................................................................................................................................................
16
Error response
......................................................................................................................................................................
17
4 JSON encodings
.........................................................................................................................
18
JSON base value encodings
...............................................................................................................................................
18
JSON list encoding
...............................................................................................................................................................
19
5 Managing a REST API session
......................................................................................................
20
Connecting and authenticating
.........................................................................................................................................
20
Obtaining login session information
...................................................................................................................................
20
Logging out of the REST API session
................................................................................................................................
21
6 Querying a resource
....................................................................................................................
22
Pagination
.............................................................................................................................................................................
22
Retrieving data for multiple occurrences in a collection
.................................................................................................
22
Retrieving data for a specified resource instance
...........................................................................................................
23
Specifying the attributes to return in a query response
.................................................................................................
24
Filtering response data
........................................................................................................................................................
25
Sorting response data
.........................................................................................................................................................
27
Including data from a related resource type in a query
..................................................................................................
28
7 Creating other types of requests
.................................................................................................
32
Creating a resource instance
.............................................................................................................................................
32
Contents
Contents
3