HP 3PAR Web Service API 1.3.1 Developer's Guide

Protocol and Message Format
Clients communicate with the WSAPI server using HTTPS and data structures represented with
JSON.
URI Format
All operations of the API are performed using an HTTP method (GET, POST, PUT, or DELETE) and
a Uniform Resource Identifier (URI). In the following example, the URI corresponds to the volume
named projectXvol residing on the HP 3PAR storage system with the hostname
storsys1.example.com:
https://storsys1.example.com:8080/api/v1/volumes/projectXvol
HTTP Requests and Responses
Because HTTP/1.0 does not support chunked transfer encoding, HTTP/1.0 is not supported in
WSAPI 1.3. If an HTTP/1.0 request comes in, the WSAPI server will generate the following error
message, indicating an unsupported HTTP version.
UNSUP_HTTP
Supported HTTP Methods
The HTTP methods currently supported by the HP 3PAR WSAPI are as follows:
GET HTTP GET—Retrieves information identified by the request-URI.
POST HTTP POST—Requests that an object described by the body of the request be created
in the collection identified by the URI.
PUT HTTP PUT—Requests that an entity identified by the Request-URI be modified.
DELETE HTTP DELETE—Requests that the server delete the resource identified by the request
URI.
Client HTTP Headers
The HTTP requests that clients make to the API server include HTTP headers. Table 2 (page 16)
shows the required and optional HTTP headers. Optional headers, when present, must be one of
the values listed in the Values column. For example:
Accept: application/json; charset=UTF-8
Protocol and Message Format 15