Skip to main content
GET
/
executions
/
{executionId}
cURL
curl --request GET \
  --url https://core.us.stedi.com/2023-08-01/executions/{executionId} \
  --header 'Authorization: <api-key>'
{
  "artifacts": [
    {
      "artifactType": "application/edi-x12",
      "sizeBytes": 751,
      "model": "execution",
      "usage": "input",
      "url": "https://core.us.stedi.com/2023-08-01/executions/b1356ef2-a10d-482a-b2db-408f1d5e7ff5/input"
    },
    {
      "artifactType": "application/json",
      "sizeBytes": 1024,
      "model": "execution",
      "usage": "metadata",
      "url": "https://core.us.stedi.com/2023-08-01/executions/b1356ef2-a10d-482a-b2db-408f1d5e7ff5/metadata"
    }
  ],
  "connectionId": "01J8JH26KBJTARWD17Q0S0ZD19",
  "connectionType": "bucket",
  "createdAt": "2025-02-12T22:21:08.815Z",
  "direction": "INBOUND",
  "executionId": "b1356ef2-a10d-482a-b2db-408f1d5e7ff5",
  "faultCount": 0,
  "partnershipId": "local-clearinghouse-test",
  "source": {
    "dirname": "clearinghouse/incoming",
    "name": "7a79135a-73ae-427b-b762-9d4d437d4aab.x12"
  },
  "retryable": false,
  "status": "COMPLETED",
  "transactionCount": 1,
  "updatedAt": "2025-02-12T22:21:15.839Z"
}

Authorizations

​
Authorization
string
header
required

A Stedi API Key for authentication.

Path Parameters

​
executionId
string
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 app.

Response

GetExecution 200 response

​
createdAt
string<date-time>
required

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

​
updatedAt
string<date-time>
required

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

​
executionId
string
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
enum<string>
required

The status of the execution. 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.

Available options:
COMPLETED,
PARTIALLY_COMPLETED,
FAILED,
IGNORED,
IN_PROGRESS,
RETRYING,
RETRIED,
STARTED
​
direction
enum<string>
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.

Available options:
INBOUND,
OUTBOUND,
UNKNOWN
​
transactionCount
number

The number of individual transactions included in the file.

​
faultCount
number

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

​
faultCode
enum<string>

A code specifying the reason for the fault.

Available options:
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
​
faultMessage
string

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
enum<string>

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

Available options:
CSV,
EDI/EDIFACT,
FILEPART,
JSON,
PSV,
JSON/STEDI-GUIDE,
TSV,
UNKNOWN,
EDI/X12,
XML,
ZIP
​
retryable
boolean

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

​
parentExecutionId
string

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.

​
childExecutionId
string

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.

​
partnershipId
string

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.

Required string length: 1 - 81
​
connectionType
enum<string>

The type of connection used for exchanging files.

Available options:
bucket,
remote-ftp,
stedi-ftp,
as2
​
connectionId
string

An autogenerated identifier for the connection within the Stedi platform.

​
source
object

The source of the file, including the directory where Stedi received it and the file name.

​
artifacts
object[]

A list of artifacts related to the transaction. Input artifacts represent the original transaction data Stedi received before processing. Output artifacts represent the processed data.

For example, for an inbound 835 ERA from a payer, the input artifact would be the original X12 EDI, and the output artifact would be the JSON representation of the ERA.

​
deliveryReports
object[]

Details about delivery attempts for outbound files./n/nStedi attempts to deliver a file to all configured connections every 6 minutes for up to 3 total attempts. If it cannot deliver the file after the third attempt, it marks the file execution as FAILED and emits the file failed event.