logo
logo

Datasource object

Note

Datasources are currently known as Option lists, but the renaming hasn't been fully applied yet.

Parameters

ParameterTypeDescription
nameStringCan only contain letters, numbers, dots or underscores. Because it is used as an identifier, this also needs to be unique.
labelsLabelsOptional. The translation(s) of the canonical name.
typeStringFlat disables nesting of option list items, Hierarchical enables nesting option list items. If it set to Flat and the values array contains nested items, it will throw an error.
valuesArray.<[DatasourceValue`]('datasource-value.md')>The Option list items that belong to the option list.
is_system_ownedBooleanfalse allows the option list to be editable, true locks the option list preventing any further modifications. When creating an option list using the API, you should always use false, which is the default value.

Examples

{
    "name": "Groceries",
    "labels": {
        "en-US": "Groceries",
        "nl-BE": "Boodschappen"
    },
    "type": "Hierarchical",
    "values": [
        {
            "identifier" : "Bread",
            "labels": {
                "en-US": "Bread",
                "nl-BE": "Brood"
            },
            "values" : []
        },
        {
            "identifier" : "Spreads",
            "values" : [
                {
                    "identifier" : "Peanut butter",
                    "values" : []
                },
                {
                    "identifier" : "Jam",
                    "values" : []
                }
            ]
        },
    ],
    "is_system_owned": false
}

Can we improve this article ? Provide feedback