Get Execution
Retrieve the file execution details for a given `executionId`.
/executions/{executionId}A Stedi API Key for authentication.
Path Parameters
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
The date and time when the resource was created, in ISO 8601 format. For example, 2023-08-28T00:00:00Z.
- Format:
date-time
The date and time when the resource was last updated, in ISO 8601 format. For example, 2023-08-28T00:00:00Z.
- Format:
date-time
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.
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.
COMPLETEDPARTIALLY_COMPLETEDFAILEDIGNOREDIN_PROGRESSThe 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.
INBOUNDOUTBOUNDUNKNOWNThe number of individual transactions included in the file.
The number of errors that occurred during processing. If the file was successfully processed completely, this value is 0.
A code specifying the reason for the fault.
DELIVERY_FAILUREFAILED_TO_EXTRACT_BUSINESS_IDENTIFIERSFAILED_TO_FIND_GUIDEFAILED_TO_FIND_LOCAL_PROFILEFAILED_TO_FIND_PARTNER_PROFILEA 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.
The file format. For example, EDI/EDIFACT for an EDIFACT file or EDI/X12 for an X12 EDI file.
CSVEDI/EDIFACTFILEPARTJSONPSVIf true, you can retry the file in the Stedi portal.
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.
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.
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.
- Pattern:
^([a-zA-Z0-9._-]+)$ - Required string length:
1 - 81
The type of connection used for exchanging files.
bucketremote-ftpstedi-ftpas2An autogenerated identifier for the connection within the Stedi platform.
- Pattern:
^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
The source of the file, including the directory where Stedi received it and the file name.
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.
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.
curl --request GET \
--url "https://core.us.stedi.com/2023-08-01/executions/{executionId}" \
--header "Authorization: <api_key>"fetch("https://core.us.stedi.com/2023-08-01/executions/{executionId}", {
headers: {
"Authorization": "<api_key>"
}
})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))
}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)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();
}{
"message": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"cause": {
"name": "string",
"message": "string",
"stack": "string"
}
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}