Bizagi features an OData service which handles aspects of the Experience design.
Through the Processes/Cases/Workitems URI, you may handle cases data related to the pending activities of a user (not stakeholder), as described at Activities from processes data.
This section describes how to query the list of activities of a given case.
Start off from the following URL:
•[ID_process]: The GUID of a specific process as returned when invoking the Cases from processes data.
•[ID_case]: The GUID of a specific case as returned when invoking the Cases from processes data.
•[ID_workitem]: The GUID of a specific workitem as returned when invoking Activities from processes data.
•[your_bizagi_project_url]: Corresponds to the URL where end users access the Bizagi Work portal.
For instance for an on-premise Bizagi project, such URL would be:
While for Bizagi PaaS projects, such URL would be:
To complete a workitem, the URL described above is invoked by means of an HTTP POST.
Consider including the following JSON structure to send parameters in the body:
•[xpath_name]: The exact xpath as expected by parameters of that workitem.
•[xpath_datatype]: The data type for that xpath as expected by each parameter..
•[value_for_xpath]: The value you want to set to such xpath parameter.
Notice if you have more than 1 parameter, you would use:
Similarly, if no parameters are expected (not explicitly required), then you would use:
The following image illustrates data in the body you can send in an HTTP POST.
The response you obtain confirming the completion of the activity or event contains the current workitems of that given case.
Notice this other image shows a previous invocation regarding parameters that the process expects (as you would need to send the exact data type and matching xpath information):
Refer to the following links for specific use cases:
•To filter the search with parameters, consider the notes for the different data types, as described at Values and formats for data types.
•To dynamically obtain business values that you may need as an input parameter to start a new process or complete an activity, refer to Related entities services.
•To dynamically obtain the columns you need to fill out to send when creating records in a collection, refer to Columns in collections.
•To learn how to comply to the format expected when sending dates, files and images or boolean fields, refer to Sending input parameters.