Supported Data Types
No matter what client you use to make a REST API call, both the sent request and delivered response are in JavaScript Object Notation (JSON). The following table lists the data types for resource attributes in our REST APIs.
| Data Type | Description |
|---|---|
string |
Any sequence of characters added
between double quotes. Similar to a C or Java string. Example: {"name":"Andrew"} |
date |
A string value conforming to the
ISO 8601 format. For example, the data type for DateValidated is string (date).
|
datetime |
A string value conforming to the
ISO 8601 format. For example, the data type for LastUpdateDate is string (date-time).
|
boolean
|
A value that must be either true or false.
|
number |
A numeric value represented in
base 10 with no extra leading zero. It includes digits between 0 and
9, can be negative, a fraction, or an exponent of 10 prefixed by e. The value doesn't include
the octal and hexadecimal formats.
|
integer
|
A number without a fraction part or an exponent part. |
null |
No value to assign. |
object
|
An unordered set of name and value pairs. A name is a string, and a value can be a string, a number,
a Boolean, a null, an object, or an array data type.
|
array
|
An ordered collection of values, beginning with a [ (left
bracket), ending with an ] (right bracket), and including values separated
by commas. Example: {"contacts":[
"John", "Anna", "Peter" ]} |
long text |
A string representation of a character large object (CLOB) when returned inline with other attributes. |
For additional information about JSON data types, see https://www.json.org/json-en.html.