Stedi home page
EDI Platform

Retry Executions

Queue file executions to be retried.

POST/executions/retry

The endpoint queues file executions that match the criteria specified in condition for retry. This includes child executions generated from past retry attempts - all matching executions will be queued. You can use this endpoint to programmatically handle file.failed events.

The endpoint returns an empty response upon success. You can monitor the status of retries using the Poll Executions endpoint or through the Stedi portal.

How retries work

Stedi only retries each execution ID once. That's because when you retry a file, Stedi creates a child execution with a new ID and links it to the original (parent) execution.

To retry a file multiple times, you'll need to either pass the execution ID of the latest retry attempt to this endpoint or specify a matching condition. For example, if you specify that Stedi should retry all executions with a status of FAILED, Stedi will queue all executions matching that criterion, including the latest child execution in existing retry chains.

That retry execution is linked to the original execution through the following properties:

  • parentExecutionId: The ID of the execution's parent execution, if it is part of a retry chain.
  • childExecutionId: The ID of this execution's child execution, if it is part of a retry chain.

You can also review all of a file's retry attempts in the Stedi portal.

Authorizations

Authorization
RequiredHeader

A Stedi API Key for authentication.

Body

application/json
condition
ObjectRequired

Specify the file executions to retry. Stedi will retry all executions matching the given criteria. For example, you can retry all file executions with a FAILED status within a specific date range.

Note that Stedi only retries each executionId once. Each retry attempt is stored as a new file execution within Stedi. If you need to retry a file multiple times, you'll need to pass the ID of the latest retry attempt to this endpoint.

Show attributes
executionIds
condition.executionIds
Array of StringsMax items: 1000

A list of file execution IDs. These are unique identifiers for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal.

direction
condition.direction
String

The direction of the transaction. Inbound transactions are those you receive from a payer, provider, or other trading partner. Outbound transactions are those you send to a payer, provider, or other trading partner.

Possible values
INBOUND
OUTBOUND
UNKNOWN
faultCode
condition.faultCode
String

A code specifying the reason for the fault. This code appears in the code property of the HTTP error response.

Possible values
DELIVERY_FAILURE
FAILED_TO_EXTRACT_BUSINESS_IDENTIFIERS
FAILED_TO_FIND_GUIDE
FAILED_TO_FIND_LOCAL_PROFILE
FAILED_TO_FIND_PARTNER_PROFILE
partnershipId
condition.partnershipId
String

Specify executions associated with a specific partnership. This is the partnershipId property in the file execution record. You can also find this ID on the Trading partners page under Partnership identifier.

status
condition.status
String

The status of the execution.

  • You can only retry executions with a FAILED or IGNORED status.
  • An execution is COMPLETED when Stedi has finished processing the file with no errors. If the file is an outbound file, a COMPLETED status also means that Stedi successfully delivered it to the configured connection.
Possible values
COMPLETED
PARTIALLY_COMPLETED
FAILED
IGNORED
IN_PROGRESS
from
condition.from
StringFormat: date-time

Specify executions processed after this timestamp, in ISO 8601 format. For example, 2023-08-28T00:00:00Z.

to
condition.to
StringFormat: date-time

Specify executions processed before this timestamp, in ISO 8601 format. For example, 2023-08-28T00:00:00Z.

Response

RetryExecutions 200 response

Output
Stage fragment