Activities from Work portal completion data

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > Services index > Data services > Cases from Work portal > Activities from Work portal cases >

Activities from Work portal completion data

Overview

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

Through the Cases/Workitems URI, you may handle cases data related to the pending activities of a user (not stakeholder), as described at Activities from Work portal cases.

This section describes how to query the list of activities of a given case.

 

Resource URL

Start off from the following URL:

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

 

Consider:

[ID_case]: The GUID of a specific case as returned when invoking Cases from Work portal.

[ID_workitem]: The GUID of a specific workitem as returned when invoking Activities from Work portal cases.

[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:

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

While for Bizagi PaaS projects, such URL would be:

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

 

Example

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:

{

       "startParameters": [

        {

            "xpath": "[xpath_name]",

            "type": "[xpath_datatype]",

            "value": "[value_for_xpath]"

        }

    ]

}

 

Consider:

[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:

{

       "startParameters": [

        {

            "xpath": "[xpath1_name]",

            "type": "[xpath1_datatype]",

            "value": "[value_for_xpath1]"

        },

        {

            "xpath": "[xpath2_name]",

            "type": "[xpath2_datatype]",

            "value": "[value_for_xpath2]"

        }

    ]

}

 

Similarly, if no parameters are expected (not explicitly required), then you would use:

{

 "startParameters": [

 ]

}

 

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, refer to Related entities services.

 

 

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

 

OData_Next2

 

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

 

OData_Workitems_types