Cases from Work Portal

<< Click to Display Table of Contents >>

Navigation:  Application integration > Bizagi RESTful API > Bizagi API examples > Data services examples >

Cases from Work Portal


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

Through the cases URI, you can fetch pending cases for an authenticated user, as shown in the Inbox via the Work Portal.



This resource is available for all users, not just Stakeholders.


Resource URL

Start with the following URL:




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

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


For Automation Service projects, the URL would be:




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




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 that case, as given by the process' SLA.

CreationDate: The date when the case was started. The unique URL to access the case.

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

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.



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 property, you can obtain a specific record's detail only, instead of a full list.

For example, use:






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

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

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


You can navigate into current workitems (activities or events) available for the case.

For example, use:



For more information about how to work with workitems for a case, refer to Activities from Work Portal cases.


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.