Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameactionflow
nopaneltrue

API Endpoints

This feature is available in PhixFlow version 11.1.1+. For older versions, see the API section in Actionflow Properties.

Insert excerpt
3.11 Setting up an API Endpoint
3.11 Setting up an API Endpoint
nameOverview
nopaneltrue

For full details on how to create an API Endpoint, see 3.11 Setting up an API Endpoint.

Insert excerpt
_property_icon
_property_icon
nopaneltrue
 Properties Tab

Parent Details

The name of the container that this item is within or belongs to, if applicable. See Parent Details on Common Properties.

Basic Settings

FieldDescription
NameThe name of the API Endpoint.

Actionflow Icon


A custom icon for the API Endpoint.

Upload a new icon by clicking the 

Insert excerpt
_add_icon
_add_icon
nopaneltrue
 icon or choose an image already uploaded to the application by clicking 
Insert excerpt
_image_list
_image_list
nameicon
nopaneltrue
.

URL

Displays the URL for the API that is used to call it. This field is read only.

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”.
Timeout

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.

Allow Anonymous Connections

Insert excerpt
3.11 Setting up an API Endpoint
3.11 Setting up an API Endpoint
nameAllowAnonymousConnections
nopaneltrue

Actions

Displays the actions in the API Endpoint, e.g. Calculate, Open Screen.

Input Connections

Displays the input connection points coming into the API Endpoint, and their Type. See Understanding Actionflow Node Connections.

Output Connections

Displays the output connection points going out of the API Endpoint, and their Type.

Advanced

FieldDescription
Prioritise throughput over ordering

Insert excerpt
Actionflow Properties
Actionflow Properties
namePrioritiseThroughputOverOrdering
nopaneltrue

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.

Description

FieldDescription
DescriptionA short explanation of the API Endpoint's purpose.

Insert excerpt
_security_icon
_security_icon
nopaneltrue
 Security

Insert excerpt
Understanding Actionflows
Understanding Actionflows
namesecurity
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue