Stedi Core Schemas

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Stedi Core Schemas",
  "definitions": {
    "AccessDeniedExceptionResponseContent": {
      "type": "object",
      "description": "The server response for authorization failure.",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "string"
        }
      },
      "required": [
        "message"
      ]
    },
    "Artifact": {
      "type": "object",
      "properties": {
        "artifactType": {
          "$ref": "#/components/schemas/ArtifactType"
        },
        "usage": {
          "$ref": "#/components/schemas/ArtifactUsage"
        },
        "sizeBytes": {
          "type": "number",
          "description": "The size of the artifact in bytes."
        },
        "url": {
          "type": "string",
          "description": "A URL to download the artifact."
        },
        "model": {
          "$ref": "#/components/schemas/ArtifactModel"
        }
      },
      "required": [
        "artifactType",
        "model",
        "sizeBytes",
        "url",
        "usage"
      ]
    },
    "ArtifactModel": {
      "type": "string",
      "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"
      ]
    },
    "ArtifactType": {
      "type": "string",
      "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"
      ]
    },
    "ArtifactUsage": {
      "type": "string",
      "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.\n\nFor 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"
      ]
    },
    "BadRequestExceptionResponseContent": {
      "type": "object",
      "description": "The server cannot process the request due to an apparent client error.",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "string"
        }
      },
      "required": [
        "message"
      ]
    },
    "BusinessIdentifier": {
      "type": "object",
      "properties": {
        "elementId": {
          "type": "string",
          "description": "The identifier of the element containing the business identifier in the EDI specification."
        },
        "element": {
          "type": "string",
          "description": "The element where the business identifier was found. For example, `BHT03` for 837 claims."
        },
        "name": {
          "type": "string",
          "description": "The friendly name of the business identifier. For example, `Originator Application Transaction Identifier`."
        },
        "value": {
          "type": "string",
          "description": "The value of the business identifier."
        }
      },
      "required": [
        "element",
        "elementId",
        "name",
        "value"
      ]
    },
    "CoreCharacterSet": {
      "type": "string",
      "description": "When generating EDI, the character set determines the set of characters allowed in the EDI message. Characters outside of the specified set (after applying any repairs specified in RepairOptions) will result in an error.",
      "enum": [
        "Basic",
        "Extended",
        "ExtendedHipaa"
      ]
    },
    "CoreConnectionType": {
      "type": "string",
      "description": "The type of connection used for file delivery.",
      "enum": [
        "BUCKET",
        "AS2",
        "STEDI_FTP",
        "REMOTE_FTP",
        "STEDI_ACCOUNT_FTP"
      ]
    },
    "CreateOutboundFragmentRequestContent": {
      "type": "object",
      "properties": {
        "guideId": {
          "type": "string",
          "description": "The ID of the Stedi guide for the outbound transaction setting. The guide must be configured to use fragments. You can find this ID on the **Guides** page in the Stedi portal."
        },
        "fragment": {
          "description": "The fragment to stage for outbound delivery. Without a mapping, the fragment must be < 5MB and the shape must match the Guide JSON format for the specified guide. With a mapping, the fragment must be < 4MB and the shape must match the source schema of the specified mapping."
        },
        "mappingId": {
          "type": "string",
          "description": "Specify a mapping id to transform the fragment to Stedi's Guide JSON format."
        }
      },
      "required": [
        "fragment",
        "guideId"
      ]
    },
    "CreateOutboundFragmentResponseContent": {
      "type": "object",
      "properties": {
        "fragmentGroupId": {
          "type": "string",
          "description": "The fragment group ID where you created and added the fragment."
        },
        "createdAt": {
          "type": "string",
          "description": "The time Stedi created the fragment.",
          "format": "date-time"
        },
        "fragmentId": {
          "type": "string",
          "description": "A unique ID for the fragment Stedi created within the fragment group."
        }
      },
      "required": [
        "createdAt",
        "fragmentGroupId",
        "fragmentId"
      ]
    },
    "CreatePartnershipOutboundTransactionRequestContent": {
      "type": "object",
      "properties": {
        "characterSet": {
          "$ref": "#/components/schemas/CoreCharacterSet"
        },
        "repairOptions": {
          "$ref": "#/components/schemas/RepairOptions"
        },
        "transaction": {
          "description": "The data for an EDI transaction. If you are not using a mapping, this transaction data must be < 5MB and the shape should match the [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json) format for the specified outbound transaction setting. If you are using a mapping, this transaction data must be < 4MB and the shape must match the source schema for the specified mapping."
        },
        "filename": {
          "type": "string",
          "maxLength": 300,
          "minLength": 1,
          "pattern": "^([a-zA-Z0-9.*'()!_-]+)$",
          "description": "Set a custom name for the generated EDI file. Stedi overwrites files with the same name, so we recommend making the filename unique by including a timestamp or other identifier. If you do not specify a filename, Stedi autogenerates a unique name using the same ID generated for the `fileExecutionId`."
        },
        "fragmentGroupIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 1,
          "minItems": 1,
          "description": "Specify the fragment groups to include when creating this transaction. You can only generate EDI with a fragment group once. After you include a fragment group in generation call, Stedi locks the fragment to prevent accidentally generating transactions with duplicate data."
        },
        "mappingId": {
          "type": "string",
          "description": "Specify a mapping ID to transform the transaction data to Guide JSON format. You can find the mapping ID on the [Mappings](https://www.stedi.com/app/mappings) page in the Stedi portal."
        },
        "interchangeOverrides": {
          "$ref": "#/components/schemas/InterchangeOverrides"
        }
      },
      "required": [
        "transaction"
      ]
    },
    "CreatePartnershipOutboundTransactionResponseContent": {
      "type": "object",
      "properties": {
        "transactionId": {
          "type": "string",
          "description": "This property is currently not supported. It is reserved for future use."
        },
        "fileExecutionId": {
          "type": "string",
          "description": "An ID for the process Stedi uses to generate the EDI file. This ID appears on the details page for the generated file in the Stedi portal, and you can use it to trace the file's status and delivery."
        }
      }
    },
    "CreateTransactionGroupRequestContent": {
      "type": "object",
      "properties": {
        "transaction": {
          "description": "The data for an EDI transaction. If you are not using a mapping, this transaction data must be < 5MB and the shape should match the [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json) format for the specified outbound transaction setting. If you are using a mapping, this transaction data must be < 4MB and the shape must match the source schema for the specified mapping. Either `transaction` or `async: true` is required."
        },
        "mappingId": {
          "type": "string",
          "description": "Specify a mapping id to transform the transaction to Stedi's Guide JSON format. Can not be used with async: true."
        },
        "groupOverrides": {
          "$ref": "#/components/schemas/TransactionGroupOverrides"
        },
        "async": {
          "type": "boolean",
          "description": "Determines if the transaction should be uploaded asynchronously through a presigned url. Either `transaction` or `async: true` is required. Idempotency-Key header is required when using async: true."
        }
      }
    },
    "CreateTransactionGroupResponseContent": {
      "type": "object",
      "properties": {
        "transactionGroupId": {
          "type": "string",
          "description": "The transaction group ID where you created and added the transaction."
        },
        "createdAt": {
          "type": "string",
          "description": "The time Stedi staged the transaction.",
          "format": "date-time"
        },
        "transactionId": {
          "type": "string",
          "description": "A unique ID for the staged transaction Stedi created within the group."
        },
        "uploadUrl": {
          "type": "string",
          "description": "A pre-signed URL to upload the file using a `PUT` request."
        }
      },
      "required": [
        "createdAt",
        "transactionGroupId",
        "transactionId"
      ]
    },
    "DeliveryReport": {
      "type": "object",
      "properties": {
        "createdAt": {
          "type": "string",
          "description": "The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.",
          "format": "date-time"
        },
        "id": {
          "type": "string",
          "description": "A unique identifier for the delivery attempt."
        },
        "executionId": {
          "type": "string",
          "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."
        },
        "partnershipId": {
          "type": "string",
          "description": "An identifier for the partnership within the Stedi platform."
        },
        "connectionType": {
          "$ref": "#/components/schemas/CoreConnectionType"
        },
        "connectionId": {
          "type": "string",
          "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$",
          "description": "An autogenerated identifier for the connection within the Stedi platform."
        },
        "attempt": {
          "type": "number",
          "description": "The attempt number for the delivery."
        },
        "filename": {
          "type": "string",
          "description": "The name of the file Stedi attempted to deliver."
        },
        "status": {
          "$ref": "#/components/schemas/DeliveryReportStatus"
        },
        "message": {
          "type": "string",
          "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'."
        },
        "metadata": {
          "$ref": "#/components/schemas/DeliveryReportMetadata"
        }
      },
      "required": [
        "attempt",
        "connectionId",
        "connectionType",
        "createdAt",
        "executionId",
        "filename",
        "id",
        "message",
        "partnershipId",
        "status"
      ]
    },
    "DeliveryReportMetadata": {
      "type": "object",
      "description": "Metadata about the file delivery.",
      "properties": {
        "attempts": {
          "type": "number",
          "description": "The total number of delivery attempts for the file."
        },
        "mdn_file": {
          "$ref": "#/components/schemas/MdnFile"
        }
      }
    },
    "DeliveryReportStatus": {
      "type": "string",
      "enum": [
        "FAILED",
        "DELIVERED"
      ]
    },
    "Direction": {
      "type": "string",
      "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"
      ]
    },
    "ExceptionCause": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "stack": {
          "type": "string"
        }
      }
    },
    "ExecutionFault": {
      "type": "object",
      "description": "A failure to process a given file within stedi.",
      "properties": {
        "createdAt": {
          "type": "string",
          "description": "The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.",
          "format": "date-time"
        },
        "id": {
          "type": "string"
        },
        "executionId": {
          "type": "string",
          "description": "A unique identifier for the processed file within Stedi."
        },
        "faultCode": {
          "$ref": "#/components/schemas/ExecutionFaultCode"
        },
        "faultMessage": {
          "type": "string"
        },
        "guideId": {
          "type": "string",
          "description": "The unique identifier for the Stedi guide used to process the transactions in the file.\n\nStedi guides are machine-readable specifications that describe how to structure and validate EDI files for each transaction type."
        },
        "receiverProfile": {
          "$ref": "#/components/schemas/ExecutionPartnershipProfile"
        },
        "senderProfile": {
          "$ref": "#/components/schemas/ExecutionPartnershipProfile"
        },
        "translateFaultContext": {},
        "transactionSetIdentifier": {
          "type": "string"
        },
        "release": {
          "type": "string"
        },
        "artifacts": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Artifact"
          }
        }
      },
      "required": [
        "createdAt",
        "executionId",
        "faultCode",
        "faultMessage",
        "id"
      ]
    },
    "ExecutionFaultCode": {
      "type": "string",
      "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"
      ]
    },
    "ExecutionPartnershipProfile": {
      "type": "object",
      "properties": {
        "interchangeQualifier": {
          "$ref": "#/components/schemas/X12InterchangeQualifier"
        },
        "interchangeId": {
          "type": "string",
          "maxLength": 15,
          "minLength": 1,
          "pattern": "^.*[^ ].*$"
        },
        "profileId": {
          "type": "string",
          "maxLength": 40,
          "minLength": 1,
          "pattern": "^([a-zA-Z0-9._-]+)$",
          "description": "A unique identifier for the profile within the Stedi platform."
        },
        "profileType": {
          "$ref": "#/components/schemas/ProfileType"
        },
        "applicationId": {
          "type": "string",
          "maxLength": 15,
          "minLength": 2
        }
      },
      "required": [
        "interchangeId",
        "interchangeQualifier",
        "profileId",
        "profileType"
      ]
    },
    "ExecutionSource": {
      "type": "object",
      "description": "The source of the file, including the directory where Stedi received it and the file name.",
      "properties": {
        "dirname": {
          "type": "string",
          "description": "The directory where Stedi received the file for processing."
        },
        "name": {
          "type": "string",
          "description": "The name of the file."
        }
      },
      "required": [
        "dirname",
        "name"
      ]
    },
    "ExecutionStatus": {
      "type": "string",
      "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"
      ]
    },
    "ExecutionSummary": {
      "type": "object",
      "description": "The processed executions that match the request criteria. The `items` array is empty if there are no matching executions.",
      "properties": {
        "createdAt": {
          "type": "string",
          "description": "The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.",
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "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"
        },
        "executionId": {
          "type": "string",
          "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."
        },
        "status": {
          "$ref": "#/components/schemas/ExecutionStatus"
        },
        "direction": {
          "$ref": "#/components/schemas/Direction"
        },
        "transactionCount": {
          "type": "number",
          "description": "The number of individual transactions included in the file."
        },
        "faultCount": {
          "type": "number",
          "description": "The number of errors that occurred during processing. If the file was successfully processed completely, this value is `0`."
        },
        "faultCode": {
          "$ref": "#/components/schemas/ExecutionFaultCode"
        },
        "faultMessage": {
          "type": "string",
          "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."
        },
        "fileType": {
          "$ref": "#/components/schemas/FileType"
        },
        "retryable": {
          "type": "boolean",
          "description": "If `true`, you can retry the file in the Stedi portal."
        },
        "parentExecutionId": {
          "type": "string",
          "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."
        },
        "childExecutionId": {
          "type": "string",
          "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."
        },
        "partnershipId": {
          "type": "string",
          "maxLength": 81,
          "minLength": 1,
          "pattern": "^([a-zA-Z0-9._-]+)$",
          "description": "The unique identifier for the partnership within the Stedi platform.\n\nA 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": {
          "$ref": "#/components/schemas/CoreConnectionType"
        },
        "connectionId": {
          "type": "string",
          "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$",
          "description": "An autogenerated identifier for the connection within the Stedi platform."
        },
        "source": {
          "$ref": "#/components/schemas/ExecutionSource"
        }
      },
      "required": [
        "createdAt",
        "direction",
        "executionId",
        "status",
        "updatedAt"
      ]
    },
    "FileType": {
      "type": "string",
      "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"
      ]
    },
    "GatewayTimeoutExceptionResponseContent": {
      "type": "object",
      "description": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "string"
        }
      },
      "required": [
        "message"
      ]
    },
    "GenerateEdiRequestContent": {
      "type": "object",
      "properties": {
        "characterSet": {
          "$ref": "#/components/schemas/CoreCharacterSet"
        },
        "repairOptions": {
          "$ref": "#/components/schemas/RepairOptions"
        },
        "transactionGroups": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TransactionGroup"
          },
          "minItems": 1,
          "description": "Contains one or more EDI functional groups, each containing the data for one or more EDI transactions. You can override the Application IDs (GS-02 and GS-03) for each group individually. The outbound transaction setting for each group must be configured to use the same connection. If you need to send transactions to different connections, you must call the endpoint multiple times."
        },
        "filename": {
          "type": "string",
          "maxLength": 300,
          "minLength": 1,
          "pattern": "^([a-zA-Z0-9.*'()!_-]+)$",
          "description": "Set a custom name for the generated EDI file. Stedi overwrites files with the same name, so we recommend making the filename unique by including a timestamp or other identifier. If you do not specify a filename, Stedi autogenerates a unique name using an ID."
        },
        "overrides": {
          "$ref": "#/components/schemas/InterchangeOverrides"
        },
        "interchangeUsageIndicatorOverride": {
          "$ref": "#/components/schemas/X12UsageIndicator"
        },
        "interchangeAuthorization": {
          "$ref": "#/components/schemas/X12InterchangeAuthorization"
        }
      },
      "required": [
        "transactionGroups"
      ]
    },
    "GenerateEdiResponseContent": {
      "type": "object",
      "properties": {
        "edi": {
          "type": "string",
          "description": "The EDI Stedi generated from the JSON transaction data."
        },
        "artifactId": {
          "type": "string",
          "description": "An ID for the generated EDI file."
        },
        "fileExecutionId": {
          "type": "string",
          "description": "A ID for the process Stedi uses to generate the EDI file. This ID appears on the details page for this file execution in the Stedi portal. Internally, Stedi uses this ID to place the file in Stedi's outbound queue."
        },
        "metadata": {
          "$ref": "#/components/schemas/Metadata"
        }
      },
      "required": [
        "artifactId",
        "fileExecutionId",
        "metadata"
      ]
    },
    "GenerateTransactionGroupEdiRequestContent": {
      "type": "object",
      "properties": {
        "characterSet": {
          "$ref": "#/components/schemas/CoreCharacterSet"
        },
        "repairOptions": {
          "$ref": "#/components/schemas/RepairOptions"
        },
        "filename": {
          "type": "string",
          "maxLength": 300,
          "minLength": 1,
          "pattern": "^([a-zA-Z0-9.*'()!_-]+)$",
          "description": "Set a custom name for the generated EDI file. Stedi overwrites files with the same name, so we recommend making the filename unique by including a timestamp or other identifier. If you do not specify a filename, Stedi autogenerates a unique name using an ID."
        },
        "overrides": {
          "$ref": "#/components/schemas/InterchangeOverrides"
        },
        "interchangeAuthorization": {
          "$ref": "#/components/schemas/X12InterchangeAuthorization"
        },
        "transactionOrdering": {
          "$ref": "#/components/schemas/TransactionOrdering"
        }
      }
    },
    "GenerateTransactionGroupEdiResponseContent": {
      "type": "object",
      "properties": {
        "artifactId": {
          "type": "string",
          "description": "An ID for the generated EDI file."
        },
        "fileExecutionId": {
          "type": "string",
          "description": "A ID for the process Stedi uses to generate the EDI file. This ID appears on the details page for this file execution in the Stedi portal. Internally, Stedi uses this ID to place the file in Stedi's outbound queue."
        }
      },
      "required": [
        "artifactId",
        "fileExecutionId"
      ]
    },
    "GetExecutionInputDocumentResponseContent": {
      "type": "object",
      "properties": {
        "documentDownloadUrl": {
          "type": "string",
          "description": "A URL to download the document. This URL is available for 60 minutes."
        }
      }
    },
    "GetExecutionInputDocumentUrlResponseContent": {
      "type": "object",
      "properties": {
        "documentDownloadUrl": {
          "type": "string",
          "description": "A URL to download the document. This URL is available for 60 minutes."
        }
      }
    },
    "GetExecutionMetadataDocumentResponseContent": {
      "type": "object",
      "properties": {
        "documentDownloadUrl": {
          "type": "string",
          "description": "A URL to download the document. This URL is available for 60 minutes."
        }
      }
    },
    "GetExecutionMetadataDocumentUrlResponseContent": {
      "type": "object",
      "properties": {
        "documentDownloadUrl": {
          "type": "string",
          "description": "A URL to download the document. This URL is available for 60 minutes."
        }
      }
    },
    "GetExecutionOutputDocumentResponseContent": {
      "type": "object",
      "properties": {
        "documentDownloadUrl": {
          "type": "string",
          "description": "A URL to download the document. This URL is available for 60 minutes."
        }
      }
    },
    "GetExecutionOutputDocumentUrlResponseContent": {
      "type": "object",
      "properties": {
        "documentDownloadUrl": {
          "type": "string",
          "description": "A URL to download the document. This URL is available for 60 minutes."
        }
      }
    },
    "GetExecutionResponseContent": {
      "type": "object",
      "properties": {
        "createdAt": {
          "type": "string",
          "description": "The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.",
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "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"
        },
        "executionId": {
          "type": "string",
          "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."
        },
        "status": {
          "$ref": "#/components/schemas/ExecutionStatus"
        },
        "direction": {
          "$ref": "#/components/schemas/Direction"
        },
        "transactionCount": {
          "type": "number",
          "description": "The number of individual transactions included in the file."
        },
        "faultCount": {
          "type": "number",
          "description": "The number of errors that occurred during processing. If the file was successfully processed completely, this value is `0`."
        },
        "faultCode": {
          "$ref": "#/components/schemas/ExecutionFaultCode"
        },
        "faultMessage": {
          "type": "string",
          "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."
        },
        "fileType": {
          "$ref": "#/components/schemas/FileType"
        },
        "retryable": {
          "type": "boolean",
          "description": "If `true`, you can retry the file in the Stedi portal."
        },
        "parentExecutionId": {
          "type": "string",
          "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."
        },
        "childExecutionId": {
          "type": "string",
          "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."
        },
        "partnershipId": {
          "type": "string",
          "maxLength": 81,
          "minLength": 1,
  

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stedi/refs/heads/main/json-schema/stedi-core-schemas.json