Activities from Work portal cases

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > Services index > Data services > Cases from Work portal >

Activities 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 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/cases([ID_case])/workitems

 

Customizations:

[ID_case]: The GUID of a specific case as returned when invoking the Cases from 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

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

 

OData_Workportal5

 

Returned results include (inside the value element):

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

taskName: The name (string) of the workitem.

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

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

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

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

The parameters include for each attribute:

oXpath: The full Xpath to that attribute (includes its name).

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

oType: The data type of the attribute. 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 a specific record's detail only, instead of a full list.

For example, use:

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

 

OData_Workportal9

 

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 Work portal completion data.