Relevant processes startup data

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > Services index > 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 can 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 with the following URL:

[your_bizagi_project_url]/odata/data/relevants([relevant_ID])/start

 

Customizations:

[relevant_ID]: The ID of a specific Relevant process, as returned when obtaining  the Relevant to me data.

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

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

https://[your_server]/[your_project]/odata/data/relevants([relevant_ID])/start

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/data/relevants([relevant_ID])/start

 

 

Example

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

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

{

      "startParameters": [

       {

           "xpath": "[xpath_name]",

           "type": "[xpath_datatype]",

           "value": "[value_for_xpath]"

       }

   ]

}

 

Customizations:

[xpath_name]: The exact Xpath expected by parameters of the Relevant process.

[xpath_datatype]: The data type for the Xpath as expected by each parameter.

[value_for_xpath]: The value you want to set for each Xpath parameter.

 

If you have more than one parameter, use:

{

      "startParameters": [

       {

           "xpath": "[xpath1_name]",

           "type": "[xpath1_datatype]",

           "value": "[value_for_xpath1]"

       },

       {

           "xpath": "[xpath2_name]",

           "type": "[xpath2_datatype]",

           "value": "[value_for_xpath2]"

       }

   ]

}

 

If no parameters are expected, use:

{

 "startParameters": [

 ]

}

 

note_pin

The parameters are taken from the process' start form.

If no start form is defined, parameters are blank.

 

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 (in the returned value):

 

OData_ProcessesStart2

 

The next image shows a previous invocation regarding parameters that the process expects (as you would need to send the exact data type and matching Xpath information):

 

OData_ProcessesStart1

 

Specific formats

Refer to the following links for specific use cases:

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

To dynamically obtain business values that you may need as input parameters to start a new process or complete an activity, refer to Related entities services.

To dynamically obtain the columns you need to fill out to send when creating records in a collection, refer to Columns in collections.

To learn how to comply to the format expected when sending dates, files and images or Boolean fields, refer to Sending input parameters.