STstedi

GET /executions/{executionId}

Changed on

Retrieve the file execution details for a given executionId.

Request

  • Base URL
    https://core.us.stedi.com/2023-08-01
  • URL
    https://core.us.stedi.com/2023-08-01/executions/{executionId}
  • Auth
    API key in header Authorization

Path parameters

executionIdstring required

A unique identifier 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.

Response

GetExecution 200 response

createdAtstring date-time required

The date and time when the resource was created, in ISO 8601 format. For example, 2023-08-28T00:00:00Z.

updatedAtstring date-time required

The date and time when the resource was last updated, in ISO 8601 format. For example, 2023-08-28T00:00:00Z.

executionIdstring required

A unique identifier for the processed file within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the file's details page in the Stedi portal.

status'COMPLETED' | 'PARTIALLY_COMPLETED' | 'FAILED' | 'IGNORED' | 'IN_PROGRESS' | 'RETRYING' | 'RETRIED' | 'STARTED' required

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.
direction'INBOUND' | 'OUTBOUND' | 'UNKNOWN' required

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.

transactionCountnumber

The number of individual transactions included in the file.

faultCountnumber

The number of errors that occurred during processing. If the file was successfully processed completely, this value is 0.

faultCode'DELIVERY_FAILURE' | 'FAILED_TO_EXTRACT_BUSINESS_IDENTIFIERS' | 'FAILED_TO_FIND_GUIDE' | 'FAILED_TO_FIND_LOCAL_PROFILE' | 'FAILED_TO_FIND_PARTNER_PROFILE' | 'FAILED_TO_FIND_PARTNERSHIP' | 'FAILED_TO_FIND_PROFILES' | 'FAILED_TO_FIND_RECEIVER_PROFILE' | 'FAILED_TO_FIND_SENDER_PROFILE' | 'FAILED_TO_FIND_CONNECTION' | 'FAILED_TO_GENERATE_CONTROL_NUMBERS' | 'FAILED_TO_PARSE' | 'FAILED_TO_PARSE_METADATA' | 'FAILED_TO_TRANSLATE' | 'FAILED_TO_ACK' | 'FAILED_TO_ACK_INTERCHANGE' | 'FILE_NOT_FOUND' | 'INVALID_EVENT' | 'INVALID_CONFIGURATION' | 'MISMATCHED_PARTNERSHIP_CONNECTION' | 'MISSING_FUNCTIONAL_GROUP_CONTROL_NUMBER' | 'MISSING_FUNCTIONAL_GROUP_RELEASE' | 'MISSING_INTERCHANGE_CONTROL_NUMBER' | 'MISSING_TRANSACTION_SET_CONTROL_NUMBER' | 'MISSING_RECEIVER_ID' | 'MISSING_RECEIVER_QUALIFIER' | 'MISSING_SENDER_ID' | 'MISSING_SENDER_QUALIFIER' | 'MULTIPLE_MATCHING_GUIDES' | 'MULTIPLE_MATCHING_TRANSACTION_SETTINGS' | 'MULTIPLE_PARTNERSHIPS' | 'NO_TRANSLATION_OUTPUT' | 'NO_TRANSACTION_SETS' | 'NOT_SUPPORTED' | 'NO_FUNCTIONAL_GROUPS' | 'NO_USAGE_INDICATOR_CODE' | 'PREVIOUSLY_RETRIED' | 'TRANSLATION_ERROR' | 'UNKNOWN_ERROR'

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

faultMessagestring

A message providing more information about the fault. Note that if there are multiple faults, Stedi sets the first fault as the code and corresponding message.

fileType'CSV' | 'EDI/EDIFACT' | 'FILEPART' | 'JSON' | 'PSV' | 'JSON/STEDI-GUIDE' | 'TSV' | 'UNKNOWN' | 'EDI/X12' | 'XML' | 'ZIP'

The file format. For example, EDI/EDIFACT for an EDIFACT file or EDI/X12 for an X12 EDI file.

retryableboolean

If true, you can retry the file in the Stedi portal.

parentExecutionIdstring

The ID of this execution's parent execution, if it is part of a retry chain. When you retry a file, Stedi creates a child execution with a new ID and links it to the original (parent) execution.

childExecutionIdstring

The ID of this execution's child execution, if it is part of a retry chain. When you retry a file, Stedi creates a child execution with a new ID and links it to the original (parent) execution.

partnershipIdstring

The unique identifier for the partnership within the Stedi platform.

A partnership describes all aspects of the EDI relationship between two profiles in your Stedi account, such as which transaction sets they will exchange and other important information for processing EDI files.

connectionType'BUCKET' | 'AS2' | 'STEDI_FTP' | 'REMOTE_FTP' | 'STEDI_ACCOUNT_FTP'

The type of connection used for file delivery.

connectionIdstring

An autogenerated identifier for the connection within the Stedi platform.

mode'test' | 'production' | 'other' | 'unknown' required

Indicates whether the file execution contains test or production data. Stedi determines this from the value in ISA15 (Usage Indicator Code).

Changes