settings/srx/find

Work in progress, not released.

Find a configuration by its locale and name.

URL

CODE

(GET) /api/settings/srx/find?name={name}&locale={locale}

PARAMETERS

The URL parameters are:

locale

Options are:

(none): Find a language independent rule.
A locale: Find the language specific rule.

Leave blank to find a language independent configuration. Set a locale (en, de, es) to find a language specific configuration.

string, Optional

name

Null or a name.

Leave blank to fetch the default configuration (which has no name even if it shows “Default” in the user interface). Otherwise, specify the name of a specific configuration.

string, Optional

RESULTS

The JSON result shows the SRX configuration properties:

CODE

{
    "id": 6501,
    "loc": "de",
    "name": "WP-665",
    "desc": "Fixes the splitting"
}

If no such configuration exists, the system returns an empty object:

CODE

{}

The properties are:

id	The SRX configuration ID	int
loc	The locale of the configuration or null for language independent rules.	string?
name	The name of the rule or null if it is the default rule for the language.	string?
desc	An optional description	string

Example: The language independent default rule has no locale nor name:

CODE

{
    "id": 6501,
    "loc": null,
    "name": null,
    "desc": null
}