Cases plus activities from Work portal

<< Click to Display Table of Contents >>

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

Cases plus activities from Work portal

Overview

Bizagi features an OData service which handles aspects of the Experience design, as described at Data services.

However through the casesWithWorkitems URI, you may fetch pending cases for the authenticated user along with their pending activities or events, as shown in the Inbox via the Work portal.

Both the cases and workitems are fetched in a single invocation.

 

note_pin

This resource is available for all users, regardless of being Stakeholders or not.

 

Resource URL

Start off from the following URL:

[your_bizagi_project_url]/odata/data/casesWithWorkitems

 

Consider:

[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/casesWithWorkitems

While for Bizagi PaaS projects, such URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/data/casesWithWorkitems

 

Example

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

 

OData_CasesWithWi

 

Returned results consider (inside of the value element):

idCase: The internal case number (integer) as used by Bizagi.

caseNumber: The case identifier (string) as customized in the project and shown to end users in the Work portal.

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

CreationDate: The date when the case was started.

@odata.id: The unique URL to access that specific case.

Workitems

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

otaskName: The name (string) of the workitem.

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

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

oParameters: The list of data (attributes) and its values, that such workitem uses.

Such parameters include for each attribute the same as the parameters above, though applicable to the workitem.

 

Recall that the main advantage of this resource is the fact that it returns workitems available for cases. For this reason, this response does not feature the Parameters structure and values for cases but for workitems.

 

note_pin

In addition to the above, for every set of results returned by the OData services, the successful response includes a set of standard properties which are preceded by the @ sign. Such properties are described at Properties and querying options.

 

Notice how through the @odata.id property, you can obtain that specific record's detail only, instead of a full list.

For example using:

[your_bizagi_project_url]/odata/data/processes([ID_process])/casesWithWorkitems([ID_case])

 

OData_CasesWithWi2

 

note_pin

In order to promote best performance, images or uploads in cases are not returned immediately per sé by this service.

Instead, an URL is provided to query such image or upload separately.

To learn more about this option, refer to URLs for Images and Uploads.

 

Customizing the returned attributes

In case you want to filter or completely change the set of attributes which return information for this invocation, refer to Setting which business information is returned.