$(document).ready(function(){highlight();});

Cases search

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > Basic concepts > Common lookup services >

Cases search

Overview

Bizagi features OData services, which handle a comprehensive set of resources, to help you work with cases.

The following section describes how to query the basic metadata of a case using its case identifier.

 

note_pin

This resource is available for all users.

 

Resource URL

Use the following URL:

[your_bizagi_project_url]/odata/data/searchByCaseNumber(caseNumber='[case_number]')

 

Customization:

[case_number]: Corresponds to case identifier, which can be a customized string (i.e, not necessarily an integer).

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

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

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

For Automation Service projects, the URL would be:

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

 

Example

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

 

OData_SearchByCase

 

 

Returned results include (inside the value element):

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

Id: The case's internal ID (an integer).

caseNumber: The case identifier that you specified for the search.

solutionDate: The date in which the case was closed.

creationDate: The date when the case was started.

processName: The name of the process.

closed: true if the case has finished; false if it is still in progress.

 

note_pin

Every set of results the OData services returns a set of standard properties which are preceded by the @ sign. Such properties are described in Properties and querying options.