Link relation settings:section-by-path

Overview

Provides the resource representing the specified settings:section.

HTTP method

GET

URL template parameters

path

List of the ancestor sections base.ids, separated by /, from the root settings:section to requested section (think Unix/POSIX file systems). The argument must be URL encoded!

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

200 OK

Response body

Available in

Description

Provides the resource representing the specified settings:section.