Dell PowerStore REST API Developers Guide

PDF

JSON base value encodings

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

NOTE:A property that has no value appears as the type null.

Table 1. JSON base value encodingsList of JSON base value encodings and their definition and format.
Type name	JSON definition	Format after "<name>":	Example	Notes
short	type: integer format: int16	<int value>	"drive_count":600	N/A
integer	type: integer format: int32	<int value>	"answer": 42	N/A
long	type: integer format: int64	<int value>	"size": 123456789	N/A
float	type: number format: float	<float value>	"progress": 99.9	N/A
double	type: number format: double	<float value>	"throughput": 123456.78	N/A
string	type: string	<string value>	"description":"some text"	Use \ to escape the quote (") and control characters.
byte	type: string format: byte	<base64 encoded character string>	"bitmask":"c3VyZS4="	Base64 encoded byte sequence.
binary	type: string format: binary	<octet sequence string>	"checksum": "1a2b3c4d1234dcba"	Hex encoded byte sequence.
boolean	type: boolean	true\|false	"force":true	Case insensitive.
date	type: string format: date	"yyyy-mm-dd"	"expiration_date": "2020-02-02"	As defined by full-date (RFC3339).
timestamp	type: string format: timestamp	"hh:mm:ss[.sss]"	"daily_start_time": "03:30:00"	As defined by partial-time (RFC3339).
date-time	type: string format: date-time	yyyy-mm-ddThh:mm:ss[.sss]Z	"updated": "2015-07-14T18:21:32.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":"wordpass"	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 hostname.	"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 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 Dell PowerStore REST API Reference Guide.
id	type: string format:	<string value>	"id":"123"	<id> value of the referenced resource instance.