This API method lets you list the workflow templates configured in the platform.

Workflow templates are then assigned to individual projects. They define workflow steps and many settings to automate projects.

GETTING STARTED

The /list API is very powerful but in most cases the following two methods will suffice:

Enumerate workflow templates:

(GET) http://{server}/api/settings/workflows/list

Get a description for all the fields included with results:

(GET) http://{server}/api/settings/workflows/fields

WORKING WITH THE /list API

NOTE: Replace */list by /api/settings/workflows/configs/list in the URLs below.

GETTING STARTED

This query searches items in status "1" and with a reference starting with "ax":

(POST) */list
HTTP BODY: { "query": '{status} = 1 AND {reference}.StartsWith("ax")' }

URLS

The following methods are available to search, count, print and aggregate your data.

Method	Description	Documentation
Querying data
*/list	Retrieve and query items with all or selected fields. Supports pagination. Parameters like query string, data fields and pagination are included in the request body.	Read more
*/list/full	Same as above but systematically includes all data fields in the results.	Read more
*/list/count	Same as above but returns just the grand total of jobs matching filter criteria.	Read more
*/list/aggregations	Get statistics such as total items per status or other criteria. Gain insight into data.	Read more
*/list/items/{id}	Get all fields for a specific item.	Read more

Field details
*/list/fields	Get list of data fields with name, description, data type and more information.	Read more

Reports
*/list/print	Download filtered data to EXCEL, XML or JSON.	Read more

Advanced methods
*/list/autocomplete	Implement auto complete functionality for selected data fields.	Read more
/list/queries/	Load and save queries for later reuse.	Read more
/list/layouts/	Load and save list/filter layouts for later reuse.	Read more

ACCESS RIGHTS

Please keep in mind that your access rights entirely decide on the data and the field values you can retrieve.

With limited rights you may not see all the jobs or projects etc., but just yours.

With limited rights you may not see some customer details or other user profile dependent information.

Access rights are exactly the same as in the Wordbee Translator system.

See also: Access Rights

EXAMPLES

Fetch 100 configuration with all fields. The body may also include filters and other options, see links above.

POST http://{server}/api/settings/documentformats/configs/list
BODY: { "take": 100 }

The result is:

{
    "total": 19,
    "count": 19,
    "rows": [
        {
            "id": 68,
            "name": "Default",
            "description": null,
            "iscodyt": 1,
            "iscodytt": "Codyt",
            "clientName": null,
            "clientId": null
        },
        {
            "id": 62,
            "name": "Back translation",
            "description": "Implements back translation workflows",
            "iscodyt": 0,
            "iscodytt": "Standard",
            "clientName": "My customer",
            "clientId": 537
        },
		....

Browser not supported