Reference Guide

Type name JSON
definition
Format after "<name>": Example Notes
date-time
type: string
format: date-
time
yyyy-mm-
ddThh:mm:ss[.sss]Z
"updated":
"2015-07-14T18:21:3
2.621Z"
As defined by full-date -
RFC3339. All times are
expressed in UTC time. The
optional [.sss] contains
fractional milliseconds.
password
type: string
format:
password
<string value> "password":"wordpas
s"
This is a string in the API and
may be presented differently
by a client (to hide typed
input). This is handled
differently on the server (for
example, the values are not
logged).
ip-
address
type: string
format: ip-
address
String containing an IPv4
address, IPv6 address, or host
name.
"mgmtAddr":"128.222
.1.2"
In this API, some attributes
support IPv4 only, while others
support both IPv4 and IPv6.
Some attributes also support
DNS names.
The help topics for individual
resource types in the
Reference content on page
43 indicate which IP address
options are supported by that
resource type.
URI
type: string
format: uri
"<url in a string>" "href": "https:/
foo.com/bar.jsp"
N/A
embedded
type: string
format:
{ "<propName>":<value1>
, … }
" health":
{ "value":0,
"description":
"OK",
"resolution":"" }
In this example, health is an
embedded type with three
attributes: value,
description, and
resolution.
enum
type: string
format:
<string value> "severity":"Error"
Enumeration values are single
token strings. Each
enumeration is defined in the
Reference content on page
43.
id
type: string
format:
<string value> "id":"123"
<id> value of the referenced
resource instance.
JSON list encoding
A JSON list is a list of values with the following format:
[ <value1>, <value2>, <value3>,...]
where:
● Square brackets enclose the list.
● Commas separate each value.
● <value> can be another list or any of the base value encoding formats.
JSON lists can be empty.
20
JSON encodings