Cases from processes data

<< Click to Display Table of Contents >>

Navigation:  Low-code Process Automation > Studio Cloud - Authoring environment > Bizagi Studio > Bizagi from external applications > Bizagi API > OData RESTful services > Bizagi API examples > Data services examples > Processes data >

Cases from processes data

Overview

Bizagi features an OData service which handles aspects of the Experience design.

Through the Processes URI, you can handle data related to the Processes of a user (not Persona) as described at Processes data.

This section describes how to query the list of cases for a given process.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/data/processes([ID_process])/cases

 

Customizations:

•[ID_process]: The GUID of a specific process as returned when invoking the Processes data.

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

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/data/processes([ID_process])/cases

 

Example

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

 

OData_DProcesses3

 

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.

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

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

Parameters included for each attribute:

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

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

 

Returned information at the root node, evaluates the entity key (@bizagi.entity) for data about which process entity these cases belong to.

 

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

For example, use:

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

 

OData_DProcesses4

 

note_pin

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 query the attachment or upload it separately.

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

 

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

For example, use:

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

 

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

 

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.


Last Updated 12/28/2022 4:34:04 PM