Data types

Primitive data types

The following primitive data types are supported: string, integer, decimal, guid, boolean, date and date-time.
Sample JSON formatting of property values:

{
    "string-property": "String value \n with line break",
    "integer-property": 1234,
    "decimal-property": 0.25,
    "guid-property": "3669dd37-ac90-4d7c-a6aa-0607e8806999",
    "boolean-property": true,
    "date-property": "2024-12-31",
    "date-time-property": "1999-10-31T19:25:06Z",
    "nullable-property": null
}

JSON formatting syntax
- Values for all types, except integer, decimal and boolean must be double-quoted.
- Use the period character as decimal separator for decimal values
- Use IOS 8601 GMT format for date-time values.

Datetime uses ISO 8601
- All datetime values are stored in UTC time using ISO 8601 and output will always be in UTC-time using following format "YYYY-MM-DDThh:mm:ssZ"
-Input of date-time values will be treated as UTC values (with or without the Z-indicator), unless a timezone suffix is supplied. All the following input values will be stored as the same UTC value: "2024-12-31T15:12:31Z", "2024-12-31T15:12:31", "2024-12-31T16:12:31+01:00"

Complex data types

In addition to primitive data type properties, you can define lookup properties that reference items in a different collection.

To create a lookup reference, use an object with a single id property with a guid value that matches the target item.
Example (for POST/PUT/PATCH requests)

{
    "string-property": "String value",
    "integer-property": 1234,
    "lookup-property": {
        "id": "2f472f3d-8639-47c5-bd2d-0a09c90b814f"
    }
}

When retrieving items with lookup properties, the referenced item is expanded, and all primitive properties of the referenced item are included.
Example (for GET requests)

{
    "id-property": "b07c71b0-7092-4a5b-b727-0c42062d15fa",
    "string-property": "String value",
    "integer-property": 1234,
    "lookup-property": {
        "id": "2f472f3d-8639-47c5-bd2d-0a09c90b814f",
        "string-property": "some text",
        "boolean-property": false
    }
}

Data types

Type	Description
string	String values. Max 1024 characters.
integer	Integer numbers. -2,147,483,648 to 2,147,483,647.
decimal	Decimal numbers. -922,337,203,685,477.5808 to 922,337,203,685,477.5807.
guid	Globally unique identifier. 128 bits represented by 34 hexadecimal charactes grouped 8-4-4-4-12 and separated by four hyphens.
boolean	true or false.
date	Date only value. From January 1, 1753 to December 31, 9999.
date-time	Date only value. From January 1, 1753 to December 31, 9999.
blob	A binary-large-object (file).
object	Any model defined in the API schema.