Reference Guide

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