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.

Through the casesWithWorkitems URI, you can 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, not just Stakeholders.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/data/casesWithWorkitems

 

Customizations:

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

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

https://[your_server]/[your_project]/odata/data/casesWithWorkitems

For Automation Service projects, the 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 include (inside the value element):

idCase: The internal case number (integer) 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 the case, as given by the process' SLA.

CreationDate: The date when the case was started.

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

Workitems

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

otaskName: The name (string).

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

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

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

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

 

The main advantage of this resource is 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

Every set of results returned by the OData services includes a set of standard properties which are preceded by the @ sign. These properties are described at Properties and querying options.

 

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

For example, use:

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

 

OData_CasesWithWi2

 

note_pin

To promote best performance, images or uploads in cases are not returned directly by this service.

Instead, the service provides a URL where you can review and upload the attachments separately.

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

 

Customizing the returned attributes

If 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.