Custom Fields

Both Components and References may have custom fields.

While you must currently use the App to create and manage custom fields, you will most likely interact with them when using the API.

To find information about the custom fields available for a workspace, you should use the workspace context resource.

Ardoq Type	JSON type	Example
Checkbox	boolean	true
DateTime	string	"2020-06-16T19:30:00.959Z"
Email	string	"hello@ardoq.com"
List	string	"item"
Number	number	42
SelectMultipleList	List<string>	["foo","bar"]
Text	string	"Hello"
TextArea	string	"Hello"
Url	string	"ardoq.com"
User	string	"562a6db79f2a2677633f9d17"

Checkbox

The Checkbox type represents a yes/no answer. The value is represented as a boolean.

{
    "customFields": {
        "my_checkbox_a": true,
        "my_checkbox_b": false
        }
}

DateTime

The DateTime type follows the ISO-8601 standard. The value is represented as a string.

{
    "customFields": {
        "my_datetime": "2020-06-16T19:30:00.959Z"
        }
}

Email

The Email type is used to refer to an email. The value is validated against a regular expression (regex) string.

{
    "customFields": {
        "my_email": "a@b"
        }
}

List

The List type is used to refer to an element of a list. The value belongs to the set of allowed values associated with the field definition.

{
    "customFields": {
        "my_list": "cat"
        }
}

Number

The Number type is used to refer to both integers and floats.

{
    "customFields": {
        "my_number_a": 42,
        "my_number_b": 3.14
        }
}

SelectMultipleList

The SelectMultipleList type is used to refer to multiple elements of a list. The value is a subset of the the set of allowed values associated with the field definition. The input will be checked to ensure that every item in the list is an allowed value.

{
    "customFields": {
        "my_selectmultiplelist": ["cat","dog"]
        }
}

Text

The Text type is used to refer to text.

{
    "customFields": {
        "my_text": "Hello world"
        }
}

TextArea

The TextArea type is used to refer to text.

{
    "customFields": {
        "my_textarea": "Hello world"
        }
}

Url

The Url type is used to refer to a Uniform Resource Locator.

{
    "customFields": {
        "my_url": "app.ardoq.com"
        }
}

User

The User type is used to refer to a user in the Ardoq System.

{
    "customFields": {
        "my_user": "562a6db79f2a2677633f9d17"
        }
}