REST API
The workflow platform supports integration with a wide range of REST APIs.
Update Users and Organizations
System Settings API
System Settings API is a set of APIs for managing the entire workflow platform. By using these APIs, system-level configurations—such as referencing and updating user information or editing organizational data—can be operated externally.
It can be integrated with identity management systems such as Microsoft Entra ID and HENNGE One to synchronize user and organizational data. It is also used when developing custom third-party applications to automate platform configuration.
Example API endpoints:
/API/UGA/Quser/addAdd a new user.
/API/User/RoleMembership/listRetrieve a list of users belonging to a specified role.
/API/Admin/SystemAuthority/addToQuserGrant system administrator privileges to a user.
Usage conditions:
Data retrieval (GET) APIs: Available in all editions.
Data update (POST) APIs: Available in the Professional edition.
For API authentication, OAuth2 (compliant with RFC 6749/6750) is used as the standard to ensure high security when accessing from external systems.
Retrieve Case Data (Process Data)
Workflow API
Workflow API is a set of APIs for managing workflow applications running on the platform and the processes (cases) flowing through them. Through these APIs, past case data can be aggregated and analyzed, and in-progress case data can be referenced or updated from external systems. By integrating with BI tools and document management systems such as Power BI, Tableau, and Microsoft SharePoint, organizations can enhance the visualization and analysis of operational data.
It is also possible to develop custom applications, such as mobile apps for processing “My Tasks” or tools for aggregating historical business data. In addition, the API supports a wide range of operations, including referencing selection masters and assigning privileged users to specific workflow applications.
Example API endpoints:
/API/OR/ProcessInstance/listRetrieve a detailed list of process instances.
/API/Admin/ProcessAuthority/addToQroleGrant workflow app privileges to a specified role.
/API/PMM/ProcessModel/{processModelInfoId}/stopDeactivate a specified workflow application.
Usage conditions:
Data retrieval (GET) APIs: Available in all editions.
Data update (POST) APIs: Available in the Professional edition.
Advance Cases (Processes)
By placing specific events or tasks in the workflow diagram (BPMN), processes (cases) can be controlled from external systems. This enables external cloud services such as Google Forms, kintone, and Salesforce to start new processes (cases) or advance in-progress processes to the next step.
When using these BPMN elements, an API key is required for authentication.
Overview of BPMN Elements for Receiving HTTP Requests
Message Start Event (HTTP)
Starts a new process upon receiving an HTTP request from an external system. Each request parameter is stored in the specified data fields.
/System/Event/MessageStart/{processModelInfoId}/{nodeId}/start?key={apiKey}
Message Start Event (Webhook)
Starts a new process upon receiving an HTTP request. The JSON request body is stored as-is in a single string-type data field.
/System/Event/MessageStartHttp/{processModelInfoId}/{nodeId}/{apiKey}/start
Receive Task (HTTP)
A waiting process receives an HTTP request and proceeds to the next step. Each request parameter is stored in the specified data fields.
/System/ReceiveTask/HttpPost/{processModelInfoId}/{nodeId}/receive?key={apiKey}
Receive Task (Webhook)
A waiting process receives an HTTP request and proceeds to the next step. The JSON request body is stored as-is in a single string-type data field.
/System/ReceiveTask/Http/{processModelInfoId}/{nodeId}/{processInstanceId}/{apiKey}/receiveBPM Platform Overview
Complete business process management lifecycle
