Actionflow Icon

When set, instead of the URL (below) being constructed using the API Endpoint name and application name, it will use the alias instead.

URL

This field is read only.

Displays the URL for the API that is used to call it.

If URL Alias (above) is populated, this URL will change accordingly and any special characters will be translated, such as, spaces to their URL encoded form (%20).

API Mode

Choose if the API Endpoint should:

• Wait for result (Synchronous) (Default): The API waits for the results or the timeout to occur. Note: If the timeout occurs the command is aborted.
• Poll for result (Asynchronous): The API is called and a response is returned immediately including the process ID. Subsequent API calls can be made using the process ID to fetch the status of the action. The asynchronous mode can be thought of as “fire and forget”.

Allow Anonymous Connections

Optional.

Specify a maximum time in milliseconds that the API will wait for.

When set, this value will override the default timeout, which is 60 seconds where API Mode is Synchronous and 500 milliseconds where API Mode is Asynchronous. 

However, if a timeout parameter has been provided in the URL calling this API, that will override both this Timeout value and the default value.

Exclusion Group

This field is case insensitive.

If this field is populated, only one Actionflow/API Endpoint with this Exclusion Group can be running at any one time. Attempting to run a second Actionflow/API Endpoint with the same exclusion group will return a warning and the Actionflow will not run. This applies whether the Actionflow is run manually or automatically using a schedule.

Exclusion Group are evaluated before any Actionflow/API Endpoints are started. 

If there is no Actionflow/API Endpoint already running with this exclusion group then the Actionflow/API Endpoint will continue. The action will be considered to be using this exclusion group from this point until the Actionflow/API Endpoint has completed.