apps/wbflex/settings/filters

Enumerates all available Flex filter configurations. This is optional but useful for creating Flex containers with the exact settings you want to apply.

Filters are configured by administrators in Wordbee Translator and allow to define how content is segmented, how pushed changes are notified and much more. See also at the bottom of this page.

Note: This method requires manager level credentials.

URL

(GET) /api/apps/wbflex/settings/filters

PARAMETERS

The URL parameters are:

pid

Optional project ID. If specified, then the system returns the configurations enabled for the project.

This is the case when a "Document Format Profile" is assigned to the project. Such a profile restricts the filter configurations that can be used.

int, Optional

RESULTS

The result is an array of filter configurations, each with these properties:

id	The configuration ID. Use this ID when creating new Flex containers.	int
name	The name of the configuration	string
description	Optional description of the configuration	string

EXAMPLES

Get configurations:

(GET) /apps/wbflex/settings/filters

Results are:

CODE

[
    {
        "id": 7135,
        "name": "Default",
        "description": null
    },
    {
        "id": 7076,
        "name": "No segmentation",
        "description": "This config disables the SRX rules"
    },
    {
        "id": 7134,
        "name": "My test",
        "description": "Just for testing"
    }
]

CONFIGERING FILTERS

Click Settings and then Wordbee Flex:

You will then get to the list of all configurations.