HP 3PAR StoreServ 7200 2-node HP 3PAR Web Service API 1.2 Developer's - Page 27

JSON Types and API Types, Table 7 API Types

Get HP 3PAR StoreServ 7200 2-node PDF manuals and user guides View all HP 3PAR StoreServ 7200 2-node manuals
Add to My Manuals
Save this manual to your list of manuals

Page 27 highlights

The values defined for an enumeration start with 1; the value 0 is unused. When using tools that deserialize JSON into a class, this allows an omitted property of enumeration type to be detected, since the member will not be assigned a non-zero value of a property and will retain its default or preset value of 0. For enumerations, the symbols used in this document are for convenience in referring to values of enumerations, but are not part of the WSAPI. Integer values representing the symbols appear in JSON objects. Clients can use any symbols with the integers. JSON Types and API Types JSON uses primitive types defined by IETF RFC 4627, including: • string • number • boolean • null The properties returned in JSON output objects and the members provided in JSON input objects use JSON primitive types with additional restrictions on valid values. Restrictions on values or format are given names that appear in the Type column in Table 7 (page 27). These API types are referenced in this guide in descriptions of JSON input and output. Table 7 API Types Type 8601 Description JSON string with time in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD, where TZD is one of the following: •Z • +hh:mm • -hh:mm NOTE: For more information, see http://www.w3.org/TR/NOTE-datetime epoch The number of seconds since 01/01/1970 GMT. Also known as "Unix epoch." Hex igint32 int32 MAC JSON string containing a hexadecimal value. JSON number restricted to a 32-bit signed integer where negative values are ignored by the server, and treated as if not present. JSON number restricted to a 32-bit signed integer. JSON string containing six groups of two hexadecimal digits. The string may or may not be separated by a hyphen (-); for example, either of the following formats is possible: • AC-16-2D-36-06-F7 • AC162D3606F7 name31 JSON string of 31 or fewer characters, in which the following characters are allowed: a-z A-Z 0-9 . (dot) - (dash) NOTE: Dash (-) is disallowed as the first character. JSON Types and API Types 27

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
The values defined for an enumeration start with 1; the value 0 is unused.
When using tools that deserialize JSON into a class, this allows an omitted property of enumeration
type to be detected, since the member will not be assigned a non-zero value of a property and
will retain its default or preset value of 0.
For enumerations, the symbols used in this document are for convenience in referring to values of
enumerations, but are not part of the WSAPI. Integer values representing the symbols appear in
JSON objects. Clients can use any symbols with the integers.
JSON Types and API Types
JSON uses primitive types defined by IETF RFC 4627, including:
•
string
•
number
•
boolean
•
null
The properties returned in JSON output objects and the members provided in JSON input objects
use JSON primitive types with additional restrictions on valid values. Restrictions on values or
format are given names that appear in the
Type
column in
Table 7 (page 27)
. These API types are
referenced in this guide in descriptions of JSON input and output.
Table 7 API Types
Description
Type
JSON string with time in ISO 8601 format:
8601
YYYY-MM-DDThh:mm:ssTZD
,
where TZD is one of the following:
•
Z
•
+hh:mm
•
-hh:mm
NOTE:
For more information, see
h
t
tp://w
w
w
.w3
.o
r
g/TR/NO
TE
-dat
e
time
The number of seconds since 01/01/1970 GMT.
epoch
Also known as “Unix epoch.”
JSON string containing a hexadecimal value.
Hex
JSON number restricted to a 32-bit signed integer where negative values are
ignored by the server, and treated as if not present.
igint32
JSON number restricted to a 32-bit signed integer.
int32
JSON string containing six groups of two hexadecimal digits. The string may
or may not be separated by a hyphen (-); for example, either of the following
formats is possible:
MAC
•
AC-16-2D-36-06-F7
•
AC162D3606F7
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.
JSON Types and API Types
27