Relevant processes startup data

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > Data services > Relevant to me data >

Relevant processes startup data

Overview

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

Through the Relevants URI, you may handle data related to the Relevant to me section of Stakeholders, as described at Relevant to me data.

This section describes how to start a new case for a Relevant process.

 

Resource URL

Start off from the following URL:

[your_bizagi_project_url]/odata/data/relevants([value_ID])/start:

 

Consider:

[value_ID]: The ID of a specific Relevant process, as returned when obtaining  the Relevant to me 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

To start a new case, the URL described above is invoked by means of an HTTP POST.

Consider including the following JSON structure to send parameters in the body:

{

       "startParameters": [

        {

            "xpath": "[xpath_name]",

            "type": "[xpath_datatype]",

            "value": "[value_for_xpath]"

        }

    ]

}

 

Consider:

[xpath_name]: The exact xpath as expected by parameters of that Relevant process.

[xpath_datatype]: The data type for that xpath as expected by each parameter..

[value_for_xpath]: The value you want to set to such xpath parameter.

 

Notice if you have more than 1 parameter, you would use:

{

       "startParameters": [

        {

            "xpath": "[xpath1_name]",

            "type": "[xpath1_datatype]",

            "value": "[value_for_xpath1]"

        },

        {

            "xpath": "[xpath2_name]",

            "type": "[xpath2_datatype]",

            "value": "[value_for_xpath2]"

        }

    ]

}

 

Similarly, if no parameters are expected, you would use:

{

 "startParameters": [

 ]

}

 

To filter the search with parameters, consider the notes for the different data types, as described at Values and formats for data types.

 

The following image illustrates data in the body you can send in an HTTP POST and the response you obtain indicating the case number of the created case (at the returned value):

 

OData_ProcessesStart2

 

Notice this other image shows a previous invocation regarding parameters that the action expects (as you would need to send the exact data type and matching xpath information):

 

OData_ProcessesStart1