Keywords

During the API Gateway Connector configuration, you can use keywords in the Value field when constructing an API request on the Request and Request mapping tabs.

Press Ctrl + Space to view the list of available keywords. The list is separated into two categories, VARIABLES and MESSAGE HEADER FIELDS. When a keyword is selected, it is shown between square brackets as, for example: [current_date].

The available variable keywords and the scenarios in which they can be used are shown in this table:

Keyword Description Scenario
current_datetime Current UTC date time is represented as yyyy-MM-dd_HH-mm-ss-SSS.
  • y: Year
  • M: Month in year
  • d: Day in month
  • H: Hour in day (0-23)
  • m: Minute in hour
  • s: Second in minute
  • S: Millisecond

Get from API

Send to API

Trigger API
current_datetime_iso

Current UTC date time represented as yyyy-MM-ddTHH:mm:ss.SSSZ.

  • y: Year
  • M: Month in year
  • d: Day in month
  • H: Hour in day (0-23)
  • m: Minute in hour
  • s: Second in minute
  • S: Millisecond
  • T: Static value used as Date/Time separator
  • Z: Static value indicating UTC offset is ± 00:00

Get from API

Send to API

Trigger API
current_date Current UTC date represented as yyyy-MM-dd.
  • y: Year
  • M: Month in year
  • d: Day in month

Get from API

Send to API

Trigger API
last_executed_datetime

The UTC date time of last execution that is represented as yyyy-MM-dd_HH-mm-ss-SSS.

  • y: year
  • M: Month in year
  • d: Day in month
  • H: Hour in day (0-23)
  • m: Minute in hour
  • s: Second in minute
  • S: Millisecond
 Get from API
last_executed_datetime_iso

The UTC date time of last execution represented as yyyy-MM-ddTHH:mm:ss.SSSZ.

  • y: Year
  • M: Month in year
  • d: Day in month
  • H: Hour in day (0-23)
  • m: Minute in hour
  • s: Second in minute
  • S: Millisecond
  • T: Static value used as Date/Time separator
  • Z: Static value indicating UTC offset is ± 00:00
 Get from API
last_executed_date

The UTC date of last execution that is represented as yyyy-MM-dd.

  • y: year
  • M: Month in year
  • d: Day in month
 Get from API

Behavior on API call failure

The last_executed_datetime and last_executed_datetime_iso values are updated only when the API call returns a successful response with an HTTP 2xx status code.

If the API call fails with a non-2xx response, this behavior applies:

  • The executed date-time value is not stored.
  • The last_executed_datetime and last_executed_datetime_iso values retain their previous values.
  • The next scheduled execution uses the same last executed value as the failed run. This behavior ensures that no data gap occurs between successful executions.

This table shows the behavior for successful and failed API calls:

Scenario last_executed_datetime or last_executed_datetime_iso updated? Next run behavior
API returns 2xx Yes. The value is updated to the timestamp of the current execution. Starts from the newly stored value.
API returns non-2xx, for example, 400, 500, or timeout No. The previous value is retained. Retries by using the same last executed value.
Note: The execution timestamp is captured when the HTTP request is created, before the response is received, but the timestamp is persisted only if the response is successful. The last executed value is persisted across connection point deactivation, connection point reactivation, and ION restarts.

Message header field keywords

This table shows the available Message header field keywords and the scenarios in which they can be used:

Keyword Description Scenario
accounting_entity The Accounting Entity that is populated in Message Header.

Send to API

Trigger API
batch_id The Batch ID that is populated in Message Header.

Send to API

Trigger API
batch_sequence The Batch Sequence that is populated in Message Header.

Send to API

Trigger API
batch_size The Batch Size that is populated in Message Header.

Send to API

Trigger API
batch_revision The Batch Revision that is populated in Message Header.

Send to API

Trigger API