Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

API Endpoints

Error rendering macro 'excerpt-include' : No link could be created for '3.11 Setting up an API Endpoint'.

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

 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  icon or choose an image already uploaded to the application by clicking .

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

Error rendering macro 'excerpt-include' : No link could be created for '3.11 Setting up an API Endpoint'.

Log Request

Enable to log the API request details in the System Console.

Log Response

Enable to log the API response in the System Console.

Actions

Displays the actions in the API Endpoint, e.g. Calculate, View.

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

When enabled, records are processed in parallel to optimise performance. This means the order records are processed is nondeterministic.

When disabled (default), records are processed in the order they are provided.

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.

 Security

Error rendering macro 'excerpt-include' : No link could be created for 'Understanding Actionflows'.

 Audit Tab

Audit Summary

See the Common Properties page, Audit Summary section.

  • No labels