projects/{pid}/workflows/list

These methods enable you to enumerate, filter, and locate workflows within a project:

Enumerate all workflows in a project.
Apply filters using a flexible query language.
Print and export lists
And much more, enhancing project management and workflow tracking.

DOCUMENTATION

All "Lists" in API 2 adhere to the same API endpoints and functionalities.

For comprehensive details, please consult the generic documentation:Lists

EXAMPLES

Get all workflows in project. Returns the most important properties for each workflow:

CODE

(POST) /api/projects/{pid}/workflows/list

Get all workflows in project. Include all workflow properties:

CODE

(POST) /api/projects/{pid}/workflows/list/all

Get all workflows that are in status “Work in progress”. See also: Query language

CODE

(POST) /api/projects/{pid}/workflows/list
BODY:
{ "query": "{status}.Matches(0)" }

Get all workflows that are in status “Work finished” since a specific date. The translated files are ready for download. We built an API that does exactly this for your convenience: projects/{pid}/workflows/list/completed

CODE

(POST) /api/projects/{pid}/workflows/list
BODY:
{ 
  "query": 
    "{status}.Matches(3) AND {statusDate}.Matches(\"2024-03-27T10:00:00Z\", \">=\") " 
}

By default, each method call returns no more than 20 rows. Use “take” to increase to up to 200. And use pagination with large numbers of workflows. See also ./list

CODE

(POST) /api/projects/{pid}/workflows/list
BODY:
{ "skip": 100, "take": 100, "query": "{status}.Matches(0)" }

For more features see: Lists

RESULTS

Check out this page to see what workflow properties are included in results:

projects/{pid}/workflows/list/completed

Append “full” to include all properties with results, e.g. .../list/full