Record Header

Header of the timeline record HeaderDto.

Parameters of the `HeaderDto` Object

Required parameters are marked with *

Field	Description
title^* `textWithTranslation`	Record header
titleAction `ActionDto`	Action upon clicking the record header
tags `TagDto[]`	Associative array of objects describing tags

`TagDto` Object

Tag in the timeline record header.

Warning

No more than two tags are allowed.

Parameters of the `TagDto` Object

Required parameters are marked with *

Field	Description
title^* `textWithTranslation`	Tag text
type^* `string`	Tag type, for example `warning`. Defines its appearance
action `ActionDto`	Action upon clicking the tag
scope `string`	Scope, for example `web`
hideIfReadonly `boolean`	Flag. Hides the tag if the user does not have edit access (default is `false`)

Possible values for the type field:

warning - Yellow background
success - Green background
failure - Red background
primary - Blue background
secondary - Gray background
lavender - Light purple

Tag options

Example Object

    "header": {
                "title": "Incoming Call",
                "titleAction": {
                    "type": "redirect",
                    "uri": "some.url"
                },
                "tags": {
                    "status2": {
                        "type": "warning",
                        "title": "not deciphered"
                    }
                }
            },

Record Header

Parameters of the ObjectParameters of the HeaderDto Object

ObjectTagDto Object

Parameters of the ObjectParameters of the TagDto Object

Example ObjectExample Object

Continue LearningContinue Learning

Parameters of the `HeaderDto` Object

`TagDto` Object

Parameters of the `TagDto` Object

Example Object

Continue Learning