Workflow administration

This page describes how to administer workflows.

Data-driven workflows, available in Semarchy xDM 2023.1 and later, are subject to specific licensing requirements; please confirm your eligibility to use such new functionality by consulting your license agreement or by contacting your Semarchy account representative prior to use.
All customers can still use the workflow feature available in previous versions (now known as legacy workflows). For more information, see Workflows (legacy).

Authentication and privileges

Systems or users administrating workflows in Semarchy xDM using the REST API must be authenticated and fulfill one of the following conditions to be authorized to call the administration endpoints:

  • Have one role with the Grant full access to the model option selected in the model privileges.

  • Have the Workflow Administrator role in the workflow definition.

  • Be either the initiator of the workflow instance, or a candidate or assignee of any user task in the workflow instance (for read-only endpoints only—​that is, list or get workflow instances, list or get user task instances).

Workflow administration REST API

The following API endpoints are available to administer workflows:

  • Workflow Instances:

    • List and get workflow instances.

    • Kill a workflow instance.

    • Retry a specific failed step of a workflow instance.

  • User Task Instances:

    • List and get user task instances.

    • Assign a user task.

    • Release a user task.

For a complete description of each API endpoint, see the REST API documentation.