Skip to main content

Get help for ARIS Process Mining functions and services

Define dependencies for a request

You can define dependencies between different endpoints. This means that the execution of a request from a specific endpoint depends on the data received by another endpoint.

You can only define a dependency for endpoints that immediately follow each other in the hierarchy.

There are two ways to define dependencies in your requests:

  • URL dependency

    Includes the value of the dependency column in the URL: "/your/api/${Dependency.<column_name>}/data".

  • Request parameter dependency

    Uses the value of the dependency column as a parameter value.

For each unique "{dependsOnParameterName}" value found in the extracted "{dependentEndpointName}" data, a request is made to this endpoint. The ${Dependency.<column_name>} placeholder in the URL or request parameter is substituted by its actual value during the request. If the column name contains any special characters, you must enclose the column name in double quotes.

Prerequisite

You configured at least two endpoints.

Procedure. Procedure
  1. Select an endpoint from the Endpoints tab.

  2. Open the request options. Click the Arrow or More options icon to display or hide the options.

  3. You can define a URL dependency.

    1. Click Depends on in the request options.

    2. Enable the This endpoint depends on the response of another endpoint option.

    3. Select the endpoint, on which the current endpoint depends, from the drop-down menu.

    4. Select a table.

    5. Select one or more table columns from the Depends on table columns drop-down menu. The selected columns are automatically added to the request URL as dependency columns.

  4. You can define a request parameter dependency.

    Create a query parameter with the value of the dependency column as a parameter value. Request parameters are automatically added to the request URL.

    key: myParam and value: ${Dependency.<column_name>}.

You defined an endpoint dependency.