Retrieve Execution

Retrieve the file execution details for a given `executionId`.

GET /executions/{executionId}

Authorizations

Authorization · Required Header

A Stedi API Key for authentication.

Path Parameters

executionId · String

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

application/json

GetExecution 200 response

createdAt · String Required Format: date-time

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

updatedAt · String Required Format: date-time

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 · 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.

Possible values

COMPLETED

PARTIALLY_COMPLETED

FAILED

IGNORED

IN_PROGRESS

direction · 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.

Possible values

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 · String

A code specifying the reason for the fault.

Possible values

DELIVERY_FAILURE

FAILED_TO_EXTRACT_BUSINESS_IDENTIFIERS

FAILED_TO_FIND_GUIDE

FAILED_TO_FIND_LOCAL_PROFILE

FAILED_TO_FIND_PARTNER_PROFILE

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 · String

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

Possible values

CSV

EDI/EDIFACT

FILEPART

JSON

PSV

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 Regex pattern: ^([a-zA-Z0-9._-]+)$ Length: 1 - 81

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 · String

The type of connection used for exchanging files.

Possible values

bucket

remote-ftp

stedi-ftp

as2

connectionId · String Regex pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$

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.

dirname · source.dirname · String Required

The directory where Stedi received the file for processing.

name · source.name · String Required

The name of the file.

artifacts · Array of Objects

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.

artifactType · artifacts[].artifactType · String Required

The format of the artifact.

Possible values

text/csv

application/edifact

application/filepart

application/json

application/pdf

usage · artifacts[].usage · String Required

The type of data the artifact contains. For example, an input artifact represents the original data Stedi received before processing, while an output artifact represents 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.

Possible values

attachment

input

metadata

output

sizeBytes · artifacts[].sizeBytes · Number Required

The size of the artifact in bytes.

url · artifacts[].url · String Required

A URL to download the artifact.

model · artifacts[].model · String Required

The model of the artifact, which indicates the type of process or operation it represents. For example, an execution artifact represents a file that was processed, a fragment artifact represents a part of a larger transaction, and a fault artifact represents an error that occurred during processing.

Possible values

execution

fragment

transaction

fault

deliveryReports · Array of Objects

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.

createdAt · deliveryReports[].createdAt · String Required Format: date-time

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

id · deliveryReports[].id · String Required

A unique identifier for the delivery attempt.

executionId · deliveryReports[].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.

partnershipId · deliveryReports[].partnershipId · String Required

An identifier for the partnership within the Stedi platform.

connectionType · deliveryReports[].connectionType · String Required

The type of connection used for exchanging files.

Possible values

bucket

remote-ftp

stedi-ftp

as2

connectionId · deliveryReports[].connectionId · String Required Regex pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$

An autogenerated identifier for the connection within the Stedi platform.

attempt · deliveryReports[].attempt · Number Required

The attempt number for the delivery.

filename · deliveryReports[].filename · String Required

The name of the file Stedi attempted to deliver.

status · deliveryReports[].status · String Required

Possible values

FAILED

DELIVERED

message · deliveryReports[].message · String Required

A message providing more information about the delivery attempt. For example `Delivered to sftp://transfer.us.stedi.com/outbound/06bdccdc-4ab9-4add-b1dc-a76a0183f299.x12'.

metadata · deliveryReports[].metadata · Object

Metadata about the file delivery.

attempts · deliveryReports[].metadata.attempts · Number

The total number of delivery attempts for the file.

mdn_file · deliveryReports[].metadata.mdn_file · Object

The location of the Message Disposition Notification (MDN). This is only relevant for AS2 connections.

repository · deliveryReports[].metadata.mdn_file.repository · String Required

The repository location of the MDN file.

pointer · deliveryReports[].metadata.mdn_file.pointer · String Required

The pointer to the specific MDN file.

cURL

curl --request GET \
  --url "https://core.us.stedi.com/2023-08-01/executions/{executionId}" \
  --header "Authorization: <api_key>"

JavaScript

fetch("https://core.us.stedi.com/2023-08-01/executions/{executionId}", {
  headers: {
    "Authorization": "<api_key>"
  }
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://core.us.stedi.com/2023-08-01/executions/{executionId}"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "<api_key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

Python

import requests

url = "https://core.us.stedi.com/2023-08-01/executions/{executionId}"

response = requests.request("GET", url, headers = {
  "Authorization": "<api_key>"
})

print(response.text)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://core.us.stedi.com/2023-08-01/executions/{executionId}"))
  .header("Authorization", "<api_key>")
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

200

{
  "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"
}

400

{
  "message": "string",
  "code": "string"
}

401

{
  "message": "string",
  "code": "string"
}

403

{
  "message": "string",
  "code": "string"
}

404

{
  "message": "string",
  "code": "string"
}

409

{
  "message": "string"
}

429

{
  "message": "string",
  "code": "string"
}

500

{
  "message": "string",
  "cause": {
    "name": "string",
    "message": "string",
    "stack": "string"
  }
}

503

{
  "message": "string",
  "code": "string"
}

504

{
  "message": "string",
  "code": "string"
}