API - Hotfolders

By using API it’s possible to manage beebox hot folders https://wordbee.atlassian.net/wiki/spaces/bb/pages/364698

URL

(GET) /api/hotfolders?token=

PARAMETERS

Parameters are:

token

The session token obtained when connecting.

RESULTS

The method returns JSON and HTTP status 200. Other HTTP status values indicate an error.

EXAMPLE

A typical result may look like:

{
    "items": [
        {
            "directory": "",
            "depth": 0,
            "translate": true,
            "targetLocales": null
        }
    ],
    "postDelivery": {
        "mode": "Disabled",
        "location": "Translations",
        "namepattern": "{name}-{trg}{ext}"
    }
}

To add new folder you should do the following call

URL

(PUT) /api/hotfolders?token=

PARAMETERS

Parameters are:

token

The session token obtained when connecting.

raw body

{"items":"{\"items\":[{\"directory\":\"\",\"depth\":0,\"translate\":true,\"targetLocales\":null}],\"postDelivery\":{\"mode\":\"ToInput\",\"location\":\"Translations\",\"namepattern\":\"{name}-{trg}{ext}\"},\"sourcedir\":\"c:\\\\beebox\\\\d6388a8e-2ad0-40ed-a852-3d22f6d3aac0\\\\in\",\"targetdir\":\"c:\\\\beebox\\\\d6388a8e-2ad0-40ed-a852-3d22f6d3aac0\\\\out\"}","depth":1,"token":"a8448937-ee42-483a-ac09-bb193fc9a5c3*d6388a8e-2ad0-40ed-a852-3d22f6d3aac0"}

HEADERS

Content-Type : application/json

RESULTS

The method returns JSON and HTTP status 200. Other HTTP status values indicate an error.