Events from Work Portal cases

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData RESTful services > Bizagi API examples > Data services examples > Cases from Work portal >

Events from Work Portal cases

Overview

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

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

This article describes how to trigger an event of a specific case, given its name.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/data/cases([caseID])/events([eventName])/next

 

Customizations:

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

[eventName]: name of the event hat you want to trigger in the Work Portal.

[your_bizagi_project_url]: The URL where end users access you Bizagi Work portal.

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

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

For Automation Service projects, the URL would be:

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

 

Example

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

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

{

      "startParameters": [

       {

           "xpath": "[xpath_name]",

           "value": "[value_for_xpath]"

       }

   ]

}

 

Customizations:

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

[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]",

           "value": "[value_for_xpath1]"

       },

       {

           "xpath": "[xpath2_name]",

           "value": "[value_for_xpath2]"

       }

   ]

}

 

If no parameters are expected (not explicitly required), 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_setEvent

 

The response you obtain confirming the completion of the event contains the the case ID.

 

OData_setEvent01