Property description

The template property defines the form that’s requested via an API call. Forms can be added as actions for the section title component.

Minimal JSON

{
    "type": "",
    "title": "",
    "apiDataKey": "",
    "elementType": ""
}
{
    "type": "form",
    "api": "https://help.dawiso.com/api/url/1",
    "formId": "unique ID within package",
    "title": "title.translationKey",
    "successApiCallToast": "title.translationKey_success",
    "errorApiCallToast": "title.translationKey_error",
    "template": [
        {
            "type": "form-attribute",
            "title": "title.translationKey_1",
            "apiDataKey": "api_data_key_1",
            "elementType": "is_checkbox",
            "api": "https://help.dawiso.com/api/url/1"
        },
        {
            "type": "form-user",
            "title": "title.translationKey_2",
            "apiDataKey": "api_data_key_2"
        },
        {
            "type": "form-user",
            "title": "title.translationKey_3",
            "apiDataKey": "api_data_key_3",
            "isMultiselect": true
        },
        {
            "type": "form-relation",
            "title": "title.translationKey_4",
            "apiDataKey": "api_data_key_4",
            "relationTypeKey": "core_related"
        }
    ]
}

Nested properties

PropertyDescriptionValuesMandatory
typeForm type. See supported type values.stringYes
titleTranslation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the name property, if you use a specific string of text for the title, this text will appear with the package key. For example, Comment Section will be displayed as package_key_comment section.stringYes
apiDataKeyUnique key of the API data.stringYes
elementTypeForm field type. Supported values are: is_checkbox, is_multiline, is_single_line, apistringYes* (for form-attribute)
relationTypeKeyRelation type (e.g., related).stringYes* (for form-relation)
apiAPI URL when elementType is api.stringNo
isMultiselectOnly for form-user. When true, the user selector allows picking multiple users and submits an array of user ids under apiDataKey. Defaults to false (single user).booleanNo

Supported type values

ValueDescription
form-attributeAdds an attribute field to the form.
form-relationAdds a relation type selector to the form.
form-userAdds a user selector to the form.