HP 3PAR Web Service API 1.3.1 Developer's Guide

Table 4 API Types (continued)
DescriptionType
• . (period)
• _ (underscore)
• - (hyphen)
A hyphen (-) is disallowed as the first character.
A name of zero characters is represented in JSON as the empty string (“”). An
unset name is represented in JSON as “null” (without the quotes).
JSON string of 31 or fewer characters, in which the following characters are
allowed:
name31
a-z
A-Z
0-9
. (dot)
- (dash)
NOTE: Dash (-) is disallowed as the first character.
An empty string enclosed in quotation marks (“”) represents a name with no
characters.
An unset name is represented in JSON as null.
JSON string of 255 or fewer characters.Print255
JSON string of 511 or fewer characters.print511
JSON number restricted to a 32-bit unsigned number.uint32
JSON string of 16 or 32 characters.WWN
For port and FC host, the WWN is always 16 characters.
Possible characters are:
0–9
a–f
A–F
: : (only in MAC addresses for host WWNs)
For example:
50014380231C647A
or:
50:01:43:80:23:1C:64:7A
JSON members suffixed with MiB represent size or space in mebibtyes where 1 MiB = 1,048,576 bytes (2
20
bytes).
Members suffixed with MB represent size or space in megabytes where 1 MB = 1,000,000 bytes (10
6
bytes).
JSON members suffixed with Pct mean percent.
Filtering in Queries
Use the query string in a request URI to return a subset of the members of a collection. The query
string portion the request URI begins after the character ? and ends with the character #, or, if the
# is not present, at the end of the string. If ? is not included in the request URI, there can be no
query string.
In WSAPI 1.3, the server supports a basic query string with a finite number of attributes on which
filtering can be applied, to hosts, virtual volumes, port devices, and FC switch collections only. The
query string must start with keyword “query” and have the following format:
For host objects Host collections can be filtered through the name and wwn
attributes. Because the name and wwn attributes are members,
respectively, of iSCSIPaths and FCPaths, a complex
20 Accessing the WSAPI