$(document).ready(function(){highlight();});

Activities from processes completion data

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > Services index > Data services > Processes data > Cases from processes data > Activities from processes data >

Activities from processes completion data

Overview

Bizagi features an OData service which handles aspects of the Experience design.

Through the Processes/Cases/Workitems URI, you can handle case 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.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/data/processes([ID_process])/cases([ID_case])/workitems([ID_workitem])/next

 

Customizations:

[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]: The URL where end users access the Bizagi Work portal.

For an on-premises Bizagi project, the URL would be:

https://[your_server]/[your_project]/odata/data/processes([ID_process])/cases([ID_case])/workitems([ID_workitem])/next

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/data/processes([ID_process])/cases([ID_case])/workitems([ID_workitem])/next

 

Example

To complete a workitem, invoke the URL described with an HTTP POST.

Consider including the following JSON structure in the body to send parameters:

{

       "startParameters": [

        {

            "xpath": "[xpath_name]",

            "type": "[xpath_datatype]",

            "value": "[value_for_xpath]"

        }

    ]

}

 

Customizations:

[xpath_name]: The exact Xpath as expected by parameters of the workitem.

[xpath_datatype]: The data type for that Xpath as expected by each parameter..

[value_for_xpath]: The value you want to set to the Xpath parameter.

 

If you have more than one parameter, use:

{

       "startParameters": [

        {

            "xpath": "[xpath1_name]",

            "type": "[xpath1_datatype]",

            "value": "[value_for_xpath1]"

        },

        {

            "xpath": "[xpath2_name]",

            "type": "[xpath2_datatype]",

            "value": "[value_for_xpath2]"

        }

    ]

}

 

If no parameters are expected (not explicitly required), use:

{

 "startParameters": [

 ]

}

 

The following image illustrates data in the body you can send in an HTTP POST.

 

OData_Next2Processes

 

The response you obtain confirming completion of the activity or event contains the current workitems of that given case.

 

The next 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):

 

OData_Workitems_typesProcesses

 

Specific formats

Refer to the following links for specific use cases:

To filter the search with parameters, consult the notes for the different data types at Values and formats for data types.

To dynamically obtain business values that you may need as input parameters 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.