Cases from processes data

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > Data services > Processes data >

Cases from processes data

Overview

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

Through the Processes URI, you may handle data related to the Processes of a user as described at Processes data.

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

 

Resource URL

Start off from the following URL:

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

 

Consider:

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

[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]/oauth2/server/token

While for Bizagi Cloud projects, such URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/oauth2/server/token

 

Example

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

 

OData_DProcesses3

 

 

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.

@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/processes([GUID])/cases([ID])

 

OData_DProcesses4

 

note_pin

Cases having images or files are not returned per sé by this service.

Instead, an URL is provided to query such image:

 

OData_DProcesses5

 

Consider that in this new invocation you may also use width and height as query parameters.

 

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.