| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
API Endpoints
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
For full details on how to create an API Endpoint, see Setting up an API Endpoint.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Parent Details
The name of the container that this item is within or belongs to, if applicable. See Parent Details on on Common Properties.
Basic Settings
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | The name of the API Endpoint. | ||||||||||
Actionflow Icon | A custom icon for the API Endpoint. Upload a new icon by clicking the | ||||||||||
| URL Alias | 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:
| ||||||||||
Allow Anonymous Connections |
| ||||||||||
| 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. |
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 Connection Points.
Double-click a connection point to view and create Input Parameters. See Setting up an API Endpoint.
Output Connections
Displays the output connection points going out of the API Endpoint, and their Type.
Logging Settings
| Field | Description |
|---|---|
| Log Requests | Disabled by default. When enabled, this creates a message in the System Console containing the HTTP Method (GET, POST, etc.), URL, client, headers and truncated request body. This is useful for debugging and testing, and should be disabled once testing is completed. |
| Log Response | Disabled by default. When enabled, this creates a message in the System Console containing the status code, status message, response headers and truncated response body. This is useful for debugging and testing, and should be disabled once testing is completed. |
Advanced
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Prioritise throughput over ordering |
| ||||||||||
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
| Field | Description |
|---|---|
| Description | A short explanation of the API Endpoint's purpose. |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Tip | ||
|---|---|---|
| ||
API Endpoints can be held in and run from a Package. |