The Executions API from Stedi — 11 operation(s) for executions.
components:
schemas:
AccessDeniedExceptionResponseContent:
description: The server response for authorization failure.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
Artifact:
properties:
artifactType:
$ref: '#/components/schemas/ArtifactType'
model:
$ref: '#/components/schemas/ArtifactModel'
sizeBytes:
description: The size of the artifact in bytes.
type: number
url:
description: A URL to download the artifact.
type: string
usage:
$ref: '#/components/schemas/ArtifactUsage'
required:
- artifactType
- model
- sizeBytes
- url
- usage
type: object
ArtifactModel:
description: 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.
enum:
- execution
- fragment
- transaction
- fault
type: string
ArtifactType:
description: The format of the artifact.
enum:
- text/csv
- application/edifact
- application/filepart
- application/json
- application/pdf
- text/psv
- text/tsv
- application/edi-x12
- application/xml
- application/zip
- image/jpeg
- image/png
- image/tiff
- text/plain
- unknown
type: string
ArtifactUsage:
description: '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.'
enum:
- attachment
- input
- metadata
- output
type: string
BadRequestExceptionResponseContent:
description: The server cannot process the request due to an apparent client error.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
BusinessIdentifier:
properties:
element:
description: The element where the business identifier was found. For example, `BHT03` for 837 claims.
type: string
elementId:
description: The identifier of the element containing the business identifier in the EDI specification.
type: string
name:
description: The friendly name of the business identifier. For example, `Originator Application Transaction
Identifier`.
type: string
value:
description: The value of the business identifier.
type: string
required:
- element
- elementId
- name
- value
type: object
CoreConnectionType:
description: The type of connection used for file delivery.
enum:
- BUCKET
- AS2
- STEDI_FTP
- REMOTE_FTP
- STEDI_ACCOUNT_FTP
type: string
DeliveryReport:
properties:
attempt:
description: The attempt number for the delivery.
type: number
connectionId:
description: An autogenerated identifier for the connection within the Stedi platform.
pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
type: string
connectionType:
$ref: '#/components/schemas/CoreConnectionType'
createdAt:
description: The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
executionId:
description: 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.
type: string
filename:
description: The name of the file Stedi attempted to deliver.
type: string
id:
description: A unique identifier for the delivery attempt.
type: string
message:
description: 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'.
type: string
metadata:
$ref: '#/components/schemas/DeliveryReportMetadata'
partnershipId:
description: An identifier for the partnership within the Stedi platform.
type: string
status:
$ref: '#/components/schemas/DeliveryReportStatus'
required:
- attempt
- connectionId
- connectionType
- createdAt
- executionId
- filename
- id
- message
- partnershipId
- status
type: object
DeliveryReportMetadata:
description: Metadata about the file delivery.
properties:
attempts:
description: The total number of delivery attempts for the file.
type: number
mdn_file:
$ref: '#/components/schemas/MdnFile'
type: object
DeliveryReportStatus:
enum:
- FAILED
- DELIVERED
type: string
Direction:
description: 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.
enum:
- INBOUND
- OUTBOUND
- UNKNOWN
type: string
ExceptionCause:
properties:
message:
type: string
name:
type: string
stack:
type: string
type: object
ExecutionFault:
description: A failure to process a given file within stedi.
properties:
artifacts:
items:
$ref: '#/components/schemas/Artifact'
type: array
createdAt:
description: The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
executionId:
description: A unique identifier for the processed file within Stedi.
type: string
faultCode:
$ref: '#/components/schemas/ExecutionFaultCode'
faultMessage:
type: string
guideId:
description: 'The unique identifier for the Stedi guide used to process the transactions in the file.
Stedi guides are machine-readable specifications that describe how to structure and validate EDI files
for each transaction type.'
type: string
id:
type: string
receiverProfile:
$ref: '#/components/schemas/ExecutionPartnershipProfile'
release:
type: string
senderProfile:
$ref: '#/components/schemas/ExecutionPartnershipProfile'
transactionSetIdentifier:
type: string
translateFaultContext: {}
required:
- createdAt
- executionId
- faultCode
- faultMessage
- id
type: object
ExecutionFaultCode:
description: A code specifying the reason for the fault. This code appears in the `code` property of the HTTP
error response.
enum:
- 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
type: string
ExecutionPartnershipProfile:
properties:
applicationId:
maxLength: 15
minLength: 2
type: string
interchangeId:
maxLength: 15
minLength: 1
pattern: ^.*[^ ].*$
type: string
interchangeQualifier:
$ref: '#/components/schemas/X12InterchangeQualifier'
profileId:
description: A unique identifier for the profile within the Stedi platform.
maxLength: 40
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
profileType:
$ref: '#/components/schemas/ProfileType'
required:
- interchangeId
- interchangeQualifier
- profileId
- profileType
type: object
ExecutionSource:
description: The source of the file, including the directory where Stedi received it and the file name.
properties:
dirname:
description: The directory where Stedi received the file for processing.
type: string
name:
description: The name of the file.
type: string
required:
- dirname
- name
type: object
ExecutionStatus:
description: "The status of the execution.\n - You can only retry executions with a `FAILED` or `IGNORED`\
\ status.\n - 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."
enum:
- COMPLETED
- PARTIALLY_COMPLETED
- FAILED
- IGNORED
- IN_PROGRESS
- RETRYING
- RETRIED
- STARTED
type: string
ExecutionSummary:
description: The processed executions that match the request criteria. The `items` array is empty if there
are no matching executions.
properties:
childExecutionId:
description: 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.
type: string
connectionId:
description: An autogenerated identifier for the connection within the Stedi platform.
pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
type: string
connectionType:
$ref: '#/components/schemas/CoreConnectionType'
createdAt:
description: The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
direction:
$ref: '#/components/schemas/Direction'
executionId:
description: 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.
type: string
faultCode:
$ref: '#/components/schemas/ExecutionFaultCode'
faultCount:
description: The number of errors that occurred during processing. If the file was successfully processed
completely, this value is `0`.
type: number
faultMessage:
description: 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.
type: string
fileType:
$ref: '#/components/schemas/FileType'
parentExecutionId:
description: 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.
type: string
partnershipId:
description: '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.'
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
retryable:
description: If `true`, you can retry the file in the Stedi portal.
type: boolean
source:
$ref: '#/components/schemas/ExecutionSource'
status:
$ref: '#/components/schemas/ExecutionStatus'
transactionCount:
description: The number of individual transactions included in the file.
type: number
updatedAt:
description: The date and time when the resource was last updated, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
required:
- createdAt
- direction
- executionId
- status
- updatedAt
type: object
FileType:
description: The file format. For example, `EDI/EDIFACT` for an EDIFACT file or `EDI/X12` for an X12 EDI file.
enum:
- CSV
- EDI/EDIFACT
- FILEPART
- JSON
- PSV
- JSON/STEDI-GUIDE
- TSV
- UNKNOWN
- EDI/X12
- XML
- ZIP
type: string
GatewayTimeoutExceptionResponseContent:
description: The server was acting as a gateway or proxy and did not receive a timely response from the upstream
server.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
GetExecutionInputDocumentResponseContent:
properties:
documentDownloadUrl:
description: A URL to download the document. This URL is available for 60 minutes.
type: string
type: object
GetExecutionInputDocumentUrlResponseContent:
properties:
documentDownloadUrl:
description: A URL to download the document. This URL is available for 60 minutes.
type: string
type: object
GetExecutionMetadataDocumentResponseContent:
properties:
documentDownloadUrl:
description: A URL to download the document. This URL is available for 60 minutes.
type: string
type: object
GetExecutionMetadataDocumentUrlResponseContent:
properties:
documentDownloadUrl:
description: A URL to download the document. This URL is available for 60 minutes.
type: string
type: object
GetExecutionOutputDocumentResponseContent:
properties:
documentDownloadUrl:
description: A URL to download the document. This URL is available for 60 minutes.
type: string
type: object
GetExecutionOutputDocumentUrlResponseContent:
properties:
documentDownloadUrl:
description: A URL to download the document. This URL is available for 60 minutes.
type: string
type: object
GetExecutionResponseContent:
properties:
artifacts:
description: '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.'
items:
$ref: '#/components/schemas/Artifact'
type: array
childExecutionId:
description: 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.
type: string
connectionId:
description: An autogenerated identifier for the connection within the Stedi platform.
pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
type: string
connectionType:
$ref: '#/components/schemas/CoreConnectionType'
createdAt:
description: The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
deliveryReports:
description: 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.
items:
$ref: '#/components/schemas/DeliveryReport'
type: array
direction:
$ref: '#/components/schemas/Direction'
executionId:
description: 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.
type: string
faultCode:
$ref: '#/components/schemas/ExecutionFaultCode'
faultCount:
description: The number of errors that occurred during processing. If the file was successfully processed
completely, this value is `0`.
type: number
faultMessage:
description: 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.
type: string
fileType:
$ref: '#/components/schemas/FileType'
parentExecutionId:
description: 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.
type: string
partnershipId:
description: '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.'
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
retryable:
description: If `true`, you can retry the file in the Stedi portal.
type: boolean
source:
$ref: '#/components/schemas/ExecutionSource'
status:
$ref: '#/components/schemas/ExecutionStatus'
transactionCount:
description: The number of individual transactions included in the file.
type: number
updatedAt:
description: The date and time when the resource was last updated, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
required:
- createdAt
- direction
- executionId
- status
- updatedAt
type: object
Index:
properties:
column:
description: The column number in the document where the problem occurred.
type: number
line:
description: The line number in the document where the problem occurred.
type: number
required:
- column
- line
type: object
ListExecutionFaultsResponseContent:
description: Common output structure for list operations with pagination support.
properties:
items:
items:
$ref: '#/components/schemas/ExecutionFault'
type: array
nextPageToken:
description: Token that you can supply in subsequent requests to retrieve the next page of results. If
not returned, there are no more results.
maxLength: 1024
minLength: 1
type: string
required:
- items
type: object
ListExecutionTransactionsResponseContent:
description: Common output structure for list operations with pagination support.
properties:
items:
items:
$ref: '#/components/schemas/TransactionSummary'
type: array
nextPageToken:
description: Token that you can supply in subsequent requests to retrieve the next page of results. If
not returned, there are no more results.
maxLength: 1024
minLength: 1
type: string
required:
- items
type: object
ListExecutionsResponseContent:
description: Common output structure for list operations with pagination support.
properties:
items:
items:
$ref: '#/components/schemas/ExecutionSummary'
type: array
nextPageToken:
description: Token that you can supply in subsequent requests to retrieve the next page of results. If
not returned, there are no more results.
maxLength: 1024
minLength: 1
type: string
required:
- items
type: object
Mark:
description: The location in the document where the problem occurred. May be a single index or a range.
properties:
end:
$ref: '#/components/schemas/Index'
start:
$ref: '#/components/schemas/Index'
required:
- start
type: object
MdnFile:
description: The location of the Message Disposition Notification (MDN). This is only relevant for AS2 connections.
properties:
pointer:
description: The pointer to the specific MDN file.
type: string
repository:
description: The repository location of the MDN file.
type: string
required:
- pointer
- repository
type: object
Mode:
description: Indicates whether the transaction contains test or production data. Stedi determines this from
the value in [`ISA15` Usage Indicator Code](https://www.stedi.com/edi/x12/segment/ISA#ISA-15).
enum:
- test
- production
- other
type: string
Partnership:
description: 'Information about the associated partnership.
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.
If you''re sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary
partnership for you automatically when you set up your account.'
properties:
partnershipId:
description: '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. If you''re sending or receiving transactions through the Stedi clearinghouse, Stedi configures
the necessary partnerships for you automatically when you set up your account.'
maxLength: 81
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
partnershipType:
$ref: '#/components/schemas/PartnershipType'
receiver:
$ref: '#/components/schemas/PartnershipReceiver'
sender:
$ref: '#/components/schemas/PartnershipSender'
required:
- partnershipId
- partnershipType
- receiver
- sender
type: object
PartnershipReceiver:
description: The entity that is receiving the transaction.
properties:
profileId:
description: A unique identifier for the profile within the Stedi platform.
maxLength: 40
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
required:
- profileId
type: object
PartnershipSender:
description: The entity that initiated the transaction.
properties:
profileId:
description: A unique identifier for the profile within the Stedi platform.
maxLength: 40
minLength: 1
pattern: ^([a-zA-Z0-9._-]+)$
type: string
required:
- profileId
type: object
PartnershipType:
description: The type of partnership, which determines the EDI standard used for exchanging transactions.
enum:
- x12
- edifact
type: string
ProfileType:
enum:
- local
- partner
type: string
ResourceNotFoundExceptionResponseContent:
description: The server response when the specified resource cannot be found after an API request passes authentication
and authorization.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
ResourceUnderChangeExceptionResponseContent:
properties:
message:
type: string
required:
- message
type: object
RetryExecutionSelectionCondition:
description: '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.'
properties:
direction:
$ref: '#/components/schemas/Direction'
executionIds:
description: 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.
items:
type: string
maxItems: 1000
type: array
faultCode:
$ref: '#/components/schemas/ExecutionFaultCode'
from:
description: Specify executions processed after this timestamp, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
partnershipId:
description: 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](https://www.stedi.com/app/core/partnerships)
page under **Partnership identifier**.
type: string
status:
$ref: '#/components/schemas/ExecutionStatus'
to:
description: Specify executions processed before this timestamp, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.
format: date-time
type: string
type: object
RetryExecutionsRequestContent:
properties:
condition:
$ref: '#/components/schemas/RetryExecutionSelectionCondition'
required:
- condition
type: object
ServiceExceptionResponseContent:
properties:
exceptionCause:
$ref: '#/components/schemas/ExceptionCause'
message:
type: string
required:
- message
type: object
ServiceUnavailableExceptionResponseContent:
description: The server cannot handle the request due to technical reasons.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
ThrottlingExceptionResponseContent:
description: The server response when usage plan or account-level throttling limits exceeded.
properties:
code:
type: string
message:
type: string
required:
- message
type: object
TransactionFragmentsSummary:
description: Details about fragments included in the transaction, if applicable. Fragments break large transactions
into smaller parts for easier processing and management.
properties:
batchSize:
description: The maximum size of each fragment in kilobytes (KB). Stedi uses this to automatically split
large inbound transactions into fragments.
type: number
fragmentCount:
description: The total number of fragments in the transaction.
type: number
keyName:
description: The JSON schema key name for the segment in the Stedi guide used to split the transaction
into fragments. For example, in an 834 Health Care Benefit Enrollment and Maintenance, this would be
`member_level_detail_INS_loop`.
type: string
required:
- batchSize
- fragmentCount
- keyName
type: object
TransactionStatus:
description: A status indicating whether Stedi was able to successfully process the transaction.
enum:
- failed
- succeeded
type: string
TransactionSummary:
description: The processed transactions that match the request criteria. The `items` array is empty if there
are no matching transactions.
properties:
artifacts:
description: A list of artifacts related to the transaction.
items:
$ref: '#/components/schemas/Artifact'
type: array
businessIdentifiers:
description: Any business identifiers extracted from the transaction.
items:
$ref: '#/components/schemas/BusinessIdentifier'
type: array
direction:
$ref: '#/components/schemas/Direction'
fileExecutionId:
description: 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.
type: string
fragments:
$ref: '#/components/schemas/TransactionFragmentsSummary'
mode:
$ref: '#/components/schemas/Mode'
partnership:
$ref: '#/components/schemas/Partnership'
processedAt:
description: The date and time when Stedi processed the transaction, in ISO 8601 format. For example,
`2023-08-28T00:00:00Z`.
format: date-time
type: string
status:
$ref: '#/components/schemas/TransactionStatus'
transactionId:
description: A unique identifier for the processed transaction within Stedi. This ID is included in the
transaction processed event. You can also retrieve it manually from the transaction's details page within
the Stedi portal.
type: string
translationErrors:
description: Details about errors that prevented Stedi from processing the transaction.
items:
$ref: '#/components/schemas/TranslationError'
type: array
x12:
$ref: '#/components/schemas/X12TransactionSummary'
required:
- artifacts
- direction
# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stedi/refs/heads/main/openapi/stedi-executions-api-openapi.yml