Dell Unity™ Family Unisphere® Management REST API Programmer's Guide

PDF

JSON base value encodings

The following table shows the JSON encodings for each base type:


Type	Format after "<name>":	Example	Notes
boolean	true\|t\|1 yes\|y false\|f no\|n\|0	"force":true	Case insensitive. All of the listed formats are accepted as input, but the returned output is always `true\|false`.
dateTime	yyyy-mm-ddThh:mm:ss[.sss]Z	"updated": "2015-07-14T18:21:32.621Z"	Times are expressed in ISO 8601 UTC time (GMT time). The [.sss] optional part contains optional, fractional seconds (in milliseconds).
datetime[interval]	h+:mm:ss[.sss]	300:02:15	Time interval expressed in hours, minutes, seconds, and optionally milliseconds. When used as an input value, the resolution of datetime is documented in the Unisphere Management REST API Reference Guide, and its value is rounded down to the specified unit.
embedded	{ "<propName>":<value1>, … }	" health": { "value":0, "description": "OK", "resolution":"" }	In this example, health is an embedded type with three attributes: value, description, and resolution.
enum	<int value>	"severity":3	Enumerations, which are integer values with name/value mapping defined in the data model. For the definitions of each enumeration, see the Unisphere Management REST API Reference Guide.
id	double quoted string	"id":"123"	<id> value of the referenced resource instance. This is the same as the FriendlyId value that the CLI exposes.
int	<int value>	"answer": 42	N/A
IPAddress	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 port numbers, and/or DNS names. When used in method parameters, some IPAddress type values support /bits to specify the v4 netmask or v6 prefix length. The Help topics for individual resource types in the Unisphere Management REST API Reference Guide indicate which IP address options are supported by that resource type.
pair	{value1:value2}	{"en-US":"message text"}	A list of pairs forms a JSON map.
ref	{"id":"value"}	"pool":{"id":"123"}	The ref type value is the embedding of the target instance. For requests, the ref type value is populated with the <id> value of the referenced resource. For join output in GET responses, the ref type value is populated with more of the embedded reference property values. In the example, ref refers to a pool resource with an id value of 123.
string	double quoted string	"description":"some text"	Use \ to escape the quote (") and control characters.