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

Activities from processes data

<< Click to Display Table of Contents >>

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

Activities from processes data

Overview

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

Through the Processes/Cases URI, you may handle cases data related to the pending activities of a user (not stakeholder), as described at Cases 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

 

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.

[your_bizagi_project_url]: The URL where end users access your 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

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

 

Example

The following image illustrates how you can send an HTTP GET for this resource:

 

OData_Workportal8

 

Returned results include, for each workitem (inside the value element):

id: The internal identifier (integer) (typically an activity or event instance).

taskName: The name (string).

state: The state in terms of: red (overdue/expired), yellow (at risk), or green (on-time).

SolutionDate: The estimated solution date for the case, as given by the process' SLA.

@odata.id: The unique URL to access the workitem.

Parameters: The list of data (attributes) and values that the workitem uses.

The parameters include for each attribute:

oXpath: The full Xpath (includes its name).

oValue: The value held for that case in such Xpath.

oType: The data type. For a list of possible values regarding data types in Bizagi, refer to Types of data.

oId: The identifier for the Xpath.

 

Through the @odata.id property, you can obtain the record's details only, instead of a full list.

For example, use:

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

 

OData_Workportal10

 

For a given workitem, you can send out parameters to complete it (as if clicking Next in the Work portal for that activity or event).

For more information about how to complete workitems, refer to Activities from processes completion data.