Services index

<< Click to Display Table of Contents >>

Navigation:  OData services >

Services index

Overview

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

Note that 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 at Bizagi API.

 

Base URL

Recall that the following services all start off from the [your_bizagi_project_url] base URL.

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]

While for Bizagi PaaS projects, such URL would be:

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

 

Data services

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

 

General use

These resources manage different information.

 

HTTP method

URL

Description

Further detail

GET

/odata/data

Lists all data resources (static information).

Data services.

GET

odata/data/stakeholders

Lists the name of Stakeholders set 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 of a given searched case number.

Cases search.

 

My stuff

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

 

HTTP method

URL

Description

Further detail

GET

/odata/data/stuff

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

My stuff.

GET

/odata/data/stuff([id_stuff])

Obtains information of a given collection set of my stuff.

Same link above.

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.

Same link above.

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.

Same link above.

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.

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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 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 a given record of a given collection of my stuff).

Same link above.

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.

Same link above.

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.

Same link above.

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 a given related entity attribute of a given record from a collection of my stuff).

Same link above.

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 a given related entity attribute of a given record from a collection of my stuff).

Same link above.

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).

Same link above.

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).

Same link above.

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 a given related entity attribute, 2 levels down, of a given record from a collection of my stuff).

Same link above.

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 a given related entity attribute, 2 levels down, of a given record from a collection of my stuff).

Same link above.

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).

Same link above.

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).

Same link above.

 

Searches

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

 

HTTP method

URL

Description

Further detail

GET

/odata/data/searches

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

Searches data.

GET

/odata/data/searches([id_search])

Obtains information of a given search.

Same link above.

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.

Same link above.

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.

Same link above.

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.

Same link above.

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.

Same link above.

GET

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

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

Same link above.

GET

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

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

Same link above.

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.

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

 

 

Relevant processes

These resources access relevant processes for a Stakeholder.

 

HTTP method

URL

Description

Further detail

GET

/odata/data/relevants

Lists all relevant processes.

Relevant to me.

GET

/odata/data/relevants([id_relevant])

Obtains information of a given relevant process.

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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.

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

 

 

 

Processes

These resources access processes.

 

HTTP method

URL

Description

Further detail

GET

/odata/data/processes

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

Processes data.

GET

/odata/data/processes([id_process])

Obtains information of a given process.

Same link above.

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).

Same link above.

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).

Same link above.

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).

Same link above.

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 of a given action available for a given process.

Same link above.

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 for a given process.

Same link above.

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 of a given action available of a pending case for a given process.

Same link above.

POST

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

/actions([id_action])/execute

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

Same link above.

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.

Same link above.

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 of a given workitem (pending activity or event), for a pending case of a given process.

Same link above.

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.

Same link above.

GET

/odata/data/processes([id_process])/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 of a given process.

Same link above.

GET

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

/navigations

Browses for other attributes whose information need to be drilled down 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 for a pending case of a given process.

Same link above.

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.

Same link above.

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.

Same link above.

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 (for a given related entity attribute of a pending case of a given process).

Same link above.

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 (for a specific related entity attribute of a pending case of a given process).

Same link above.

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).

Same link above.

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).

Same link above.

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 (for a given related entity attribute, 2 levels down, of a pending case of a given process).

Same link above.

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 (for a specific related entity attribute, 2 levels down, of a pending case of a given process).

Same link above.

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).

Same link above.

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).

Same link above.

 

Cases

These resources access cases and their activities or events.

 

HTTP method

URL

Description

Further detail

GET

/odata/data/cases

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

Cases from Work portal.

GET

/odata/data/cases([id_case])

Obtains information of a given pending case.

Same link above.

GET

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

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

Activities from cases.

GET

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

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

Same link above.

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.

Same link above.

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.

Same link above.

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.

Same link above.

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 of a pending case.

Cases plus activities.

GET

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

Browses for other attributes whose information need to be drilled down 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.

Same link above.

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.

Same link above.

GET

/odata/data/cases([id_case])/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 pending case).

Same link above.

GET

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

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

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

Same link above.

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).

Same link above.

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).

Same link above.

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 need to be drilled down (for a given related entity attribute, 2 levels down, of a pending case).

Same link above.

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 needs to be drilled down (for a specific related entity attribute, 2 levels down, of a pending case).

Same link above.

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).

Same link above.

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).

Same link above.

 

Metadata services

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

 

HTTP method

URL

Description

Further detail

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.

Same link above.

GET

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

Obtains process actions associated with the specified process entity.

Same link above.

GET

/odata/metadata/processes([id_process})

/actions([id_action])

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

Same link above.

GET

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

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

Navigating into linked data.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])

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

Same link above.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])/navigations

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

Same link above.

GET

/odata/metadata/processes([id_process])

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

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

Same link above.

GET

/odata/metadata/processes([id_process])

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

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

Same link above.

GET

/odata/metadata/processes([id_process])

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

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

Same link above.

GET

/odata/metadata/stakeholders

Lists all available Stakeholders.

Stakeholders description.

GET

/odata/metadata/stakeholders([id_stakeholder])

Obtains information regarding a given Stakeholder.

Same link above.

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 of a my stuff collection for a given Stakeholder.

Same link above.

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 of a given action for a given my stuff collection of a Stakeholder.

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations

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

Navigating into linked data.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

/navigations([id_navigation])

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

/navigations([id_navigation])/navigations

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

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

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches

Lists all searches for a given Stakeholder.

Searches description.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])

Obtains specific information of a search for a given Stakeholder.

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/actions

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

 

GET

/odata/metadata/stakeholders([id_stakeholder])

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

Obtains specific information of a given action for a given search of a given Stakeholder.

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations

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

Navigating into linked data.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

/navigations

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

/navigations([id_navigation])

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

/navigations([id_navigation])/navigations

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

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

/navigations([id_navigation])/navigations

/([id_navigation])

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

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants

Lists all relevant processes for a given Stakeholder.

Relevant processes description.

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants([id_relevant])

Obtains specific information of a relevant process for a given Stakeholder.

Same link above.

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants([id_relevant])/actions

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

 

GET

/odata/metadata/stakeholders([id_stakeholder])

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

Obtains specific information of a given action for a given relevant process for a given Stakeholder.

Same link above.