Cases 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 from Work portal

Overview

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

However through the cases URI, you may fetch pending cases for the authenticated user, as shown in the Inbox via the Work portal.

 

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/cases

 

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/cases

While for Bizagi PaaS projects, such URL would be:

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

 

Example

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

 

OData_Allcases

 

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.

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

Such parameters include for each attribute:

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

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

 

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

 

OData_Workportal6

 

 

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.

 

You may also further navigate into current workitems (activities or events) available for that case.

For example using:

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

 

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

 

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.