Services index

<< Click to Display Table of Contents >>

Navigation:  Application integration > Bizagi RESTful API >

Services index

Overview

When using Bizagi OData API, the following services and resources are available for your use.

There are two different OData services: one to access business data (resources classified as part of the data services), and another to access system configuration regarding Stakeholders definitions (resources classified as part of the metadata services), as described in the Bizagi API.

 

Base URL

The following services start off from the [your_bizagi_project_url] base URL.

Consider:

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

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

https://[your_server]/[your_project]

For Automation Service projects, the URL would be:

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

 

Data services

Data services help you access data for general use for these different elements: my stuff (i.e, the stuff resource), searches, relevant processes (like the relevant resource), processes, cases, queries and entities.

 

General use

These resources manage different information.

 

 

HTTP method

URL

Description

Further details

GET

/odata/data

Lists all data resources (static information).

Data services

GET

odata/data/stakeholders

Lists the name of Stakeholders in your project.

Stakeholder data

GET

/odata/data/userProfile

Obtains information regarding the authenticated user.

User profile

GET

/odata/Image

Obtains detail of an image (base 64).

URLs for Images and Uploads

GET

/odata/data/searchByCaseNumber(caseNumber='[id_case]')

Obtains detail for a given case number.

Cases search

GET

/odata/data/queries

Lists all query forms in your project

Queries Data

GET

/odata/data/entities

Lists all manageable entities (parameter entities and stakeholders)

Entities data

 

My stuff

These resources start from information obtained for a Stakeholder's my stuff.

 

HTTP method

URL

Description

Further details

GET

/odata/data/stuff

Lists all collections set as my stuff (applicable to a Stakeholder, starting from this resource).

My stuff

GET

/odata/data/stuff([id_stuff])

Obtains information of a given collection set of my stuff.

GET

/odata/data/stuff([id_stuff])/actions

Lists all actions available for a given collection of my stuff.

My stuff's action data

GET

/odata/data/stuff([id_stuff])/actions([id_action])

Obtains specific information of a given action available for a given collection of my stuff.

GET

/odata/data/stuff([id_stuff])/values

Obtains all records of a given collection of my stuff.

My stuff

GET

/odata/data/stuff([id_stuff])/values([id_value])

Obtains a given record of a given collection of my stuff.

GET

/odata/data/stuff([id_stuff])/values([id_value])/actions

Lists all actions available for a given record of a given collection of my stuff.

My stuff's action data

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])

Obtains specific information of a given action available for a record of a given collection of my stuff.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/relatedEntities

Lists all attributes which are related entities needed to fire an action (of a given record of a given collection of my stuff).

Related entities values

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/relatedEntities([id_related])

Obtains a given attribute which is a related entity needed to fire an action (of a given record of a given collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/relatedEntities([id_related])/values

Obtains all possible values of a given attribute which is a related entity, needed to fire an action (of a given record of a given collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/relatedEntities([id_related])

/values([id_value])

Obtains a given value of a given attribute which is a related entity, needed to fire an action (of a given record of a given collection of my stuff).

POST

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/execute

Executes an action available for a given record of a given collection of my stuff.

Executed actions data

GET

/odata/data/stuff([id_stuff])/values([id_value])/navigations

Browses for other attributes whose information need to be drilled down for (for a given record of a given collection of my stuff).

Navigating into linked data

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])

Browses for a given attribute whose information needs to be drilled down for (for a given record of a given collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity, for a given record of a given collection of my stuff.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity, for a given record of a given collection of my stuff.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])/navigations

Browses for other attributes whose information need to be drilled down for (for a given related entity attribute of a given record from a collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Browses for a given attribute whose information needs to be drilled down for (for a given related entity attribute of a given record from a collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity (for a given related entity attribute of a given record from a collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity (for a given related entity attribute of a given record from a collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations

Browses for other attributes whose information need to be drilled down for (for a given related entity attribute, 2 levels down, of a given record from a collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Browses for a given attribute whose information needs to be drilled down for (for a given related entity attribute, 2 levels down, of a given record from a collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity (for a given related entity attribute, 2 levels down, of a given record from a collection of my stuff).

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])
/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity (for a given related entity attribute, 2 levels down, of a given record from a collection of my stuff).

 

Searches

These resources access searches and data obtained from them, for a Stakeholder.

 

HTTP method

URL

Description

Further details

GET

/odata/data/searches

Lists all searches (applicable to a Stakeholder, starting from this resource).

Searches data

GET

/odata/data/searches([id_search])

Obtains information of a given search.

GET

/odata/data/searches([id_search])/actions

Lists all actions available for a given search.

Searches actions data

GET

/odata/data/searches([id_search])/actions([id_action])

Obtains information of a given action available for a given search.

POST

/odata/data/searches([id_search])/performSearch

Executes a given search.

Searches execution

GET

/odata/data/searches([id_search])/relatedEntities

Obtains the set of entities that are specified as Entity parameter type required by the process to start a case.

Related entities values

GET

/odata/data/searches([id_search])

/relatedEntities([id_related])

Obtains additional information about a specific entity required by a given process as an Entity parameter to start a case.

GET

/odata/data/searches([id_search])

/relatedEntities([id_related])/values

Obtains the set of possible values of a given entity required by a specific process to star a case.

GET

/odata/data/searches([id_search])

/relatedEntities([id_related])/values([id_value])

Obtains additional information about a specific value of a given entity required by a specific process to start a case.

GET

/odata/data/searches([id_search])/results

Obtains results of a given search, which is executed without sending parameters.

GET

/odata/data/searches([id_search])/results([id_result])

Obtains a specific result of a given search, which is executed without sending parameters.

GET

/odata/data/searches([id_search])/results([id_result])

/actions

Lists all actions available for a given result of a given search executed without sending parameters.

Searches actions data

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])

Obtains a specific action available for a given result of a given search executed without sending parameters.

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/relatedEntities

Obtains all possible values of a given attribute which is a related entity, needed to fire an action (available for a given result of a given search executed without sending parameters).

Related entities values

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/relatedEntities([id_related])

Obtains a given attribute which is a related entity needed to fire an action (available for a given result of a given search executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/relatedEntities([id_related])/values

Obtains all possible values of a given attribute which is a related entity, needed to fire an action (available for a given result of a given search executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/relatedEntities([id_related])

/values([id_value])

Obtains a specific value of a given attribute which is a related entity, needed to fire an action (available for a given result of a given search executed without sending parameters).

POST

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/execute

Executes an action (available for a given result of a given search executed without sending parameters).

Searches execution.

GET

odata/data/searches([id_search])/results([id_result])

/navigations

Browses for other attributes whose information need to be drilled down for a given result of a given search (which is executed without sending parameters).

Navigating into linked data

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])

Browses for a given attribute whose information needs to be drilled down for a given result of a given search (which is executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity, for a given result of a given search (which is executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity, for a given result of a given search (which is executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations

Browses for other attributes whose information need to be drilled down (for a given related entity attribute of a given result coming from a search executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Browses for a given attribute whose information needs to be drilled down (for a given related entity attribute of a given result coming from a search executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity (for a given related entity attribute of a given result coming from a search executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity (for a given related entity attribute of a given result coming from a search executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations

Browses for other attributes whose information needs to be drilled down (for a given related entity attribute, 2 levels down, of a given result coming from a search executed without sending parameters).

GET

[/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Browses for a given attribute whose information needs to be drilled down (for a given related entity attribute, 2 levels down, of a given result coming from a search executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity (for a given related entity attribute, 2 levels down, of a given result coming from a search executed without sending parameters).

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity (for a given related entity attribute, 2 levels down, of a given result coming from a search executed without sending parameters).

 

 

Relevant processes

These resources access relevant processes for a Stakeholder.

 

HTTP method

URL

Description

Further details

GET

/odata/data/relevants

Lists all relevant processes.

Relevant to me

GET

/odata/data/relevants([id_relevant])

Obtains information about a given relevant process.

POST

/odata/data/relevants([id_relevant])/start

Fires a new case for a relevant process.

Relevant process startup

GET

/odata/data/relevants([id_relevant])/relatedEntities

Lists all attributes which are related entities needed to fire a new case (of a given relevant process).

Related entities values

GET

/odata/data/relevants([id_relevant])

/relatedEntities([id_related])

Obtains a given attribute which is a related entity needed to fire a new case (of a given relevant process).

GET

/odata/data/relevants([id_relevant])

/relatedEntities([id_related])/values

Obtains all possible values of a given attribute which is a related entity, needed to fire a new case (of a given relevant process).

GET

/odata/data/relevants([id_relevant])

/relatedEntities([id_related])/values([id_value])

Obtains a given value of a given attribute which is a related entity, needed to fire a new case (of a given relevant process).

GET

/odata/data/relevants([id_relevant])/actions

Lists all actions available for a given relevant process.

Searches actions data

GET

/odata/data/relevants([id_relevant])/actions([id_action])

Obtains information of a given action available for a given relevant process.

GET

/odata/data/relevants([id_relevant])/actions([id_action])

/relatedEntities

Lists all attributes which are related entities needed to fire an action (of a given relevant process).

Related entities values

GET

/odata/data/relevants([id_relevant])/actions([id_action])

/relatedEntities([id_related])

Obtains a given attribute which is a related entity needed to fire an action (of a given relevant process).

GET

/odata/data/relevants([id_relevant])/actions([id_action])

/relatedEntities([id_related])/values

Obtains all possible values of a given attribute which is a related entity, needed to fire an action (of a given relevant process).

GET

/odata/data/relevants([id_relevant])/actions([id_action])

/relatedEntities([id_related])/values([id_value])

Obtains a given value of a given attribute which is a related entity, needed to fire an action (of a given relevant process).

 

Processes

These resources access processes.

 

HTTP method

URL

Description

Further details

GET

/odata/data/processes

Lists all processes (applicable to a Stakeholder, starting from this resource).

Processes data

GET

/odata/data/processes([id_process])

Obtains information about a given process.

GET

/odata/data/processes([id_process])/relatedEntities

Lists all attributes which are related entities of a given process (its start form).

Related entities values

GET

/odata/data/processes([id_process])

/relatedEntities([id_related])

Obtains a given attribute which is a related entity of a given process (its start form).

GET

/odata/data/processes([id_process])

/relatedEntities([id_related])/values

Obtains all possible values of a given attribute which is a related entity of a given process (its start form).

GET

/odata/data/processes([id_process])

/relatedEntities([id_related])/values([id_value])

Obtains a specific value of a given attribute which is a related entity of a given process (its start form).

GET

/odata/data/processes([id_process])/actions

Lists all actions available for a given process.

Searches actions data

GET

/odata/data/processes([id_process])/actions([id_action])

Obtains specific information about a given action available for a given process.

POST

/odata/data/processes([id_process])/start

Fires a new case for a given process.

Processes startup

GET

/odata/data/processes([id_process])/cases

Obtains all pending cases for a given process.

Cases from processes data

GET

/odata/data/processes([id_process])/cases([id_case])

Obtains information of a given pending case about a given process.

GET

/odata/data/processes([id_process])/cases([id_case])

/actions

Lists all actions available of a given pending case for a given process.

Searches actions data

GET

/odata/data/processes([id_process])/cases([id_case])

/actions([id_action])

Obtains information about a given action available of a pending case for a given process.

POST

/odata/data/processes([id_process])/cases([id_case])

/actions([id_action])/execute

Executes an action available for a pending case for a given process.

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems

Lists all workitems (pending activities or events) of a pending case for a given process.

Activities from cases

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])

Obtains information of a given workitem (pending activity or event) of a pending case for a given process.

POST

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/next

Executes a given workitem (pending activity or event) of a pending case for a given process.

Activities from process completion

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/relatedEntities

Lists all attributes which are related entities of a given workitem (pending activity or event), for a pending case of a given process.

Related entities values

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/relatedEntities([id_related])

Obtains a given attribute which is a related entity about a given workitem (pending activity or event), for a pending case of a given process.

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/relatedEntities([id_related])

/values

Obtains all possible values of a given attribute which is a related entity of a given workitem (pending activity or event), for a pending case of a given process.

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/relatedEntities([id_related])

/values([id_value])

Obtains the specific value of a given attribute which is a related entity of a given workitem (pending activity or event), for a pending case of a given process.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations

Browses for other attributes whose information need to be drilled down to for a pending case of a given process.

Navigating into linked data

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])

Browses for a given attribute whose information needs to be drilled down to for a pending case of a given process.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity, for a pending case of a given process.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity, for a pending case of a given process.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations

Browses for other attributes whose information need to be drilled down to (for a given related entity attribute of a pending case of a given process).

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Browses for a given attribute whose information needs to be drilled down to (for a specific related entity attribute of a pending case of a given process).

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity (for a specific related entity attribute of a pending case of a given process).

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity (for a specific related entity attribute of a pending case of a given process).

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations

Browses for other attributes whose information need to be drilled down to (for a given related entity attribute, 2 levels down, of a pending case of a given process).

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Browses for a given attribute whose information needs to be drilled down to (for a specific related entity attribute, 2 levels down, of a pending case of a given process).

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity (for a specific related entity attribute, 2 levels down, of a pending case of a given process).

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity (for a specific related entity attribute, 2 levels down, of a pending case of a given process).

 

Cases

These resources access cases and their activities or events.

 

HTTP method

URL

Description

Further details

GET

/odata/data/cases

Lists all pending cases (applicable to any user, starting from this resource).

Cases from Work Portal

GET

/odata/data/cases([id_case])

Obtains information about a given pending case.

GET

/odata/data/cases([id_case])/workitems

Lists all workitems (pending activities or events) about a pending case.

Activities from cases

GET

/odata/data/cases([id_case])/workitems([id_workitem]

Obtains information about a given workitem (pending activity or event) of a pending case.

GET

/odata/data/cases([id_case])/workitems([id_workitem])

/relatedEntities

Lists all attributes which are related entities of a given workitem (pending activity or event), for a pending case.

Related entities values

GET

/odata/data/cases([id_case])/workitems([id_workitem])

/relatedEntities([id_related])

Obtains a given attribute which is a related entity of a given workitem (pending activity or event), for a pending case.

GET

/odata/data/cases([id_case])/workitems([id_workitem])

/relatedEntities([id_related])/values

Obtains all possible values of a given attribute which is a related entity of a given workitem (pending activity or event), for a pending case.

GET

/odata/data/cases([id_case])/workitems([id_workitem])

/relatedEntities([id_related])/values([id_value])

Obtains a specific value of a given attribute which is a related entity of a given workitem (pending activity or event), for a pending case.

POST

/odata/data/cases([id_case])/workitems([id_workitem])/next

Executes a given workitem (pending activity or event) of a pending case.

Activities from cases in Work Portal

GET

/odata/data/casesWithWorkitems

Lists all workitems (pending activities or events), plus the information about a pending case.

Cases plus activities

GET

/odata/data/cases([id_case])/navigations

Browses for other attributes whose information needs to be drilled down to for a pending case.

Navigating into linked data

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values

Obtains all information about a given attribute in a related entity, for a pending case.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])

Obtains specific information about a given attribute in a related entity, for a pending case.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations

Browses for other attributes whose information needs to be drilled down to (for a given related entity attribute of a pending case).

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

Browses for a given attribute whose information needss to be drilled down to (for a specific related entity attribute of a pending case).

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity (for a specific related entity attribute of a pending case).

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

/values([id_value])

Obtains specific information about a given attribute in a related entity (for a specific related entity attribute of a pending case).

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

/values([id_value])/navigations

Browses for other attributes whose information needs to be drilled down to (for a given related entity attribute, 2 levels down, of a pending case).

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

Browses for a given attribute whose information needss to be drilled down to (for a specific related entity attribute, 2 levels down, of a pending case).

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])/values

Obtains all information about a given attribute in a related entity (for a specific related entity attribute, 2 levels down, of a pending case).

GET

[your_bizagi_project_url]/odata/data/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtains specific information about a given attribute in a related entity (for a specific related entity attribute, 2 levels down, of a pending case).

 

Queries

This resources access Queries set on the project, their parameters, and allow their remote execution.

 

HTTP method

URL

Description

Further details

GET

/odata/data/queries

Lists all Queries set on the project.

Queries data

GET

/odata/data/queries([ID_query])

Obtains information of the specific query

GET

/odata/data/queries([ID_query])/parameters

Lists all parameters available for the given query

GET

/odata/data/queries([ID_query])/parameters([ID_param])

Obtains information of the specific parameter of the specified quey

GET

/odata/data/queries([ID_query])/parameters([ID_param])/values

Obtains the list of possible values of an Entity type parameter

No detail

GET

/odata/data/queries([ID_query])/parameters([ID_param])/values([ID_value])

Obtains additional information regarding the specified value of the Entity

POST

/odata/data/queries([ID_query])/executeQuery

Executes the specified query using the parameters sent in the request's body

Queries data

 

 

Entities

This resources access manageable entities (such as parameter entities), their values and parameters.

 

HTTP method

URL

Description

Further details

GET

/odata/data/entities

Lists all manageable entities

Entities data

GET

/odata/data/entities([ID_entity])

Obtains additional information about the specified entity

GET

/odata/data/entities([ID_entity])/values

Obtains the list of values of the specified entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

Obtains additional information regarding a specific value of an entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/creationParameters

Obtains all parameters that can be sent to create a new register of the specified entity

Creation parameters

GET

/odata/data/entities([ID_entity])/values([ID_value])

/creationParameters([ID_param])

Obtains information regarding a parameter that can be sent to create a new register of the specified entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/creationParameters([ID_param])/values

Obtains the list of possible values of that parameter, in case it is of type Entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/creationParameters([ID_param])/values([ID_value])

Obtains additional information about a possible value of a specific parameter, in case it is of type Entity

POST

/odata/data/entities([ID_entity])/create

Creates a new value on the specified entity, based on the parameters sent in the request

GET

/odata/data/entities([ID_entity])/values([ID_value])/editionParameters

Obtains the list of parameters defined in the Edit Form that can be sent to edit a value on a given entity

Entities data

GET

/odata/data/entities([ID_entity])/values([ID_value])/editionParameters([ID_param])

Obtains additional details regarding a specific parameter needed to edit a value of a given entity

GET

/odata/data/entities([ID_entity])/values([ID_value])/editionParameters([ID_param])/values

Obtains the set of possible values when the given parameter is of type Entity

GET

/odata/data/entities([ID_entity])/values([ID_value])/editionParameters([ID_param])/values([ID_value])

Obtains additional information about a possible value of a type Entity parameter that can be sent to edit a value of an entity

POST

/odata/data/entities([ID_entity])/values([ID_value])/update

Updates the given value on the specified entity, based on the parameters sent on the request

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations

Browses for other related entities to the specified one

Navigating into linked data

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])

Obtains details regarding the specified related entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values

Obtains the values for the specified related entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values([ID_values])

Obtains specific information about a given value of the specified related entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values([ID_values])

/navigations

Browses for other related entities to the specified one

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])

Obtains details regarding the specified related entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])/values

Obtains the values for the specified related entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])/values([ID_values])

Obtains specific information about a given value of the specified related entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])/values([ID_values])

/navigations

Browses for other related entities to the specified one

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])

Obtains details regarding the specified related entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])/values

Obtains the values for the specified related entity

GET

/odata/data/entities([ID_entity])/values([ID_value])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])/values([ID_values])

/navigations([ID_navigation])/values([ID_values])

Obtains specific information about a given value of the specified related entity

 

Metadata services

Available Metadata services allow you to access information of configured Stakeholders.

 

HTTP method

URL

Description

Further details

GET

/odata/metadata

Lists all metadata resources (static information).

Metadata services

GET

/odata/metadata/getProject()

Obtains information regarding the current project.

Project description

GET

/odata/metadata/processes

Lists all available processes.

Processes description

GET

/odata/metadata/processes([id_process])

Obtains information regarding a given process.

GET

/odata/metadata/processes([id_process])/actions

Obtains process actions associated with the specified process entity.

GET

/odata/metadata/processes([id_process})

/actions([id_action])

Obtains additional information about a process action associated with a specific process entity.

GET

/odata/metadata/processes([id_process])/navigations

Browses for other attributes whose information needs to be drilled down to.

Navigating into linked data

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])

Browses for other attributes whose information needs to be drilled down to.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])/navigations

Browses for other attributes whose information needs to be drilled down to into a 2nd level.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])/navigations([id_navigation])

Browses for other attributes whose information needs to be drilled down to into a 2nd level.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])/navigations([id_navigation])/navigations

Browses for other attributes whose information needs to be drilled down to into a 3rd level.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])/navigations([id_navigation])/navigations([id_navigation])

Browses for other attributes whose information needs to be drilled down to into a 3rd level.

GET

/odata/metadata/stakeholders

Lists all available Stakeholders.

Stakeholders description

GET

/odata/metadata/stakeholders([id_stakeholder])

Obtains information regarding a given Stakeholder.

GET

/odata/metadata/stakeholders([id_stakeholder])/stuff

Lists all my stuff collections for a given Stakeholder.

My stuff description

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])

Obtains specific information about a my stuff collection for a given Stakeholder.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/actions

Lists all actions of a given my stuff collection for a given Stakeholder.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/actions([id_action])

Obtains specific information about a given action for a given my stuff collection of a Stakeholder.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations

Browses for other attributes whose information needs to be drilled down to.

Navigating into linked data

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])

Browses for other attributes whose information needs to be drilled down to.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])/navigations

Browses for other attributes whose information needs to be drilled down to into a 2nd level.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])

/navigations([id_navigation])

Browses for other attributes whose information needs to be drilled down to into a 2nd level.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])

/navigations([id_navigation])/navigations

Browses for other attributes whose information needs to be drilled down to into a 3rd level.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])

/navigations([id_navigation])/navigations([id_navigation])

Browses for other attributes whose information needs to be drilled down to into a 3rd level.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches

Lists all searches by a given Stakeholder.

Searches description

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])

Obtains specific information about a search by a given Stakeholder.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/actions

Lists all actions of a given search by a given Stakeholder.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/actions([id_action])

Obtains specific information about a given action by a given search of a given Stakeholder.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations

Browses for other attributes whose information needs to be drilled down to.

Navigating into linked data

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

Browses for other attributes whose information needs to be drilled down to.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

/navigations

Browses for other attributes whose information needs to be drilled down to into a 2nd level.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

/navigations([id_navigation])

Browses for other attributes whose information needs to be drilled down to into a 2nd level.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

/navigations([id_navigation])/navigations

Browses for other attributes whose information needs to be drilled down to into a 3rd level.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

/navigations([id_navigation])/navigations

/([id_navigation])

Browses for other attributes whose information needs to be drilled down to into a 3rd level.

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants

Lists all relevant processes by a given Stakeholder.

Relevant processes description

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants([id_relevant])

Obtains specific information about a relevant process by a given Stakeholder.

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants([id_relevant])/actions

Lists all actions of a given relevant process by a given Stakeholder.

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants([id_relevant])/actions([id_action])

Obtains specific information about a given action by a given relevant process by a given Stakeholder.

 

Query services

Available Query services allow you to access information of your Master entities without using a Bizagi Query.

 

HTTP method

URL

Description

Further details

GET

/odata/query/entities

Lists all the entities and attributes that can be queried

Query Services

POST

/odata/query/executeEntityQuery

Execute a query  with the information provided in the JSON.