Services index

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services >

Services index

Overview

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

 

Data services

Available Data services are:

 

GET   [your_bizagi_project_url]/odata/data

GET   [your_bizagi_project_url]/odata/data/stuff

GET   [your_bizagi_project_url]/odata/data/stuff([id_stuff])

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

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

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

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

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

GET   [your_bizagi_project_url]/odata/data/stuff([id_stuff])/values([id_value])/actions([id_action])/relatedEntities

GET   [your_bizagi_project_url]/odata/data/stuff([id_stuff])/values([id_value])/actions([id_action])/relatedEntities([id_related])

GET   [your_bizagi_project_url]/odata/data/stuff([id_stuff])/values([id_value])/actions([id_action])/relatedEntities([id_related])/values

POST [your_bizagi_project_url]/odata/data/stuff([id_stuff])/values([id_value])/actions([id_action])/execute

 

GET   [your_bizagi_project_url]/odata/data/searches

GET   [your_bizagi_project_url]/odata/data/searches([id_search])

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

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

GET   [your_bizagi_project_url]/odata/data/searches([id_search])/actions([id_action])/relatedEntities

GET   [your_bizagi_project_url]/odata/data/searches([id_search])/actions([id_action])/relatedEntities([id_related])

GET   [your_bizagi_project_url]/odata/data/searches([id_search])/actions([id_action])/relatedEntities([id_related])/values

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

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

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

GET   [your_bizagi_project_url]/odata/data/searches([id_search])/results([id_result])/actions

GET   [your_bizagi_project_url]/odata/data/searches([id_search])/results([id_result])/actions([id_action])

GET   [your_bizagi_project_url]/odata/data/searches([id_search])/results([id_result])/actions([id_action])/relatedEntities

GET   [your_bizagi_project_url]/odata/data/searches([id_search])/results([id_result])/actions([id_action])/relatedEntities([id_related])

GET   [your_bizagi_project_url]/odata/data/searches([id_search])/results([id_result])/actions([id_action])/relatedEntities([id_related])/values

POST [your_bizagi_project_url]/odata/data/searches([id_search])/results([id_result])/actions([id_action])/execute

 

GET   [your_bizagi_project_url]/odata/data/relevants

GET   [your_bizagi_project_url]/odata/data/relevants([id_relevant])

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

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

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

GET   [your_bizagi_project_url]/odata/data/relevants([id_relevant])/actions([id_action])/relatedEntities

GET   [your_bizagi_project_url]/odata/data/relevants([id_relevant])/actions([id_action])/relatedEntities([id_related])

GET   [your_bizagi_project_url]/odata/data/relevants([id_relevant])/actions([id_action])/relatedEntities([id_related])/values

 

GET   [your_bizagi_project_url]/odata/data/stakeholders

GET   [your_bizagi_project_url]/odata/data/userProfile

 

GET   [your_bizagi_project_url]/odata/data/processes

GET   [your_bizagi_project_url]/odata/data/processes([id_process])

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

GET   [your_bizagi_project_url]/odata/data/processes([id_process])/relatedEntities([id_related])

GET   [your_bizagi_project_url]/odata/data/processes([id_process])/relatedEntities([id_related])/values

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

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

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

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

GET   [your_bizagi_project_url]/odata/data/processes([id_process])/cases([id_case])/workitems

GET   [your_bizagi_project_url]/odata/data/processes([id_process])/cases([id_case])/workitems([id_workitem])

POST [your_bizagi_project_url]/odata/data/processes([id_process])/cases([id_case])/workitems([id_workitem])/next

GET   [your_bizagi_project_url]/odata/data/processes([id_process])/cases([id_case])/workitems([id_workitem])/relatedEntities

GET   [your_bizagi_project_url]/odata/data/processes([id_process])/cases([id_case])/workitems([id_workitem])/relatedEntities([id_related])

GET   [your_bizagi_project_url]/odata/data/processes([id_process])/cases([id_case])/workitems([id_workitem])/relatedEntities([id_related])/values

 

GET   [your_bizagi_project_url]/odata/data/cases

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

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

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

GET   [your_bizagi_project_url]/odata/data/cases([id_case])/workitems([id_workitem])/relatedEntities

GET   [your_bizagi_project_url]/odata/data/cases([id_case])/workitems([id_workitem])/relatedEntities([id_related])

GET   [your_bizagi_project_url]/odata/data/cases([id_case])/workitems([id_workitem])/relatedEntities([id_related])/values

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

GET   [your_bizagi_project_url]/odata/data/casesWithWorkitems

GET   [your_bizagi_project_url]/odata/data/casesWithWorkitems([id_case])

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

 

 

Metadata services

Available Metadata services are:

 

GET   [your_bizagi_project_url]/odata/metadata

GET   [your_bizagi_project_url]/odata/metadata/getProject

GET   [your_bizagi_project_url]/odata/metadata/processes

GET   [your_bizagi_project_url]/odata/metadata/processes([id_process])

 

GET   [your_bizagi_project_url]/odata/metadata/stakeholders

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])

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

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/stuff([id_stuff])

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/stuff([id_stuff])/actions

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/stuff([id_stuff])/actions([id_action])

 

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/searches

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/searches([id_search])

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/searches([id_search])/actions

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/searches([id_search])/actions([id_action])

 

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/relevants

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/relevants([id_relevant])

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/relevants([id_relevant])/actions

GET   [your_bizagi_project_url]/odata/metadata/stakeholders([id_stakeholder])/relevants([id_relevant])/actions([id_action])

 

Further information

For more information about the first OData service, refer to Data services.

For more information about the second OData service, refer to Metadata services.