Link relation settings:path

Overview

An array of links, which refer to the settings:section s, which are above the hierarchy of the current section.

HTTP method

GET

URI template variables

-

Query parameters

keys

Specifies a comma separated list of keys (i.e. names of settings). If specified, only those settings will the present in the returned settings:section resource.

embeds

  • sub-sections: embeds the direct sub-sections of the requested section non-recursively

lang

  • Requested language code.

    • If specified, the section and its settings contain labels in the specified language, using a language fallback mechanism if necessary.

    • If not specified, the section and its settings will contain all labels that are defined respectively.

Request body

-

HTTP response

Response body

Available in

Description

An array of links, which refer to the settings:section s, which are above the hierarchy of the current section.

The order of the links in the array is from the first element, which refers to the root-section to the direct parent-section of the current section. The titles of each link correspond to the "local" names (base.id) of the respective section making up an element of the path, whereas the special title "Root" specifies the very root-section.