List Executions

GET

executions

  curl --request GET -L \
    --url https://core.us.stedi.com/2023-08-01/executions \
    --header "Authorization: ${STEDI_API_KEY}" 

{
  "items": [
    {
      "createdAt": "2023-08-28T09:00:24.965Z",
      "direction": "OUTBOUND",
      "executionId": "f75168e4-e682-4410-bfec-b5b1541c7f21",
      "faultCount": 0,
      "partnershipId": "i-am-another-merch_this-is-me",
      "source": {
        "name": "my-execution-file.edi"
      },
      "retryable": true,
      "status": "COMPLETED",
      "transactionCount": 1,
      "updatedAt": "2023-08-28T09:00:28.741Z"
    },
    {
      "createdAt": "2023-08-28T09:17:38.591Z",
      "direction": "OUTBOUND",
      "executionId": "1bdbfae4-b30e-cab8-d90f-6fd61ef3d1da",
      "faultCount": 0,
      "partnershipId": "i-am-another-merch_this-is-me",
      "source": {
        "name": "my-execution-file.edi"
      },
      "retryable": true,
      "status": "COMPLETED",
      "transactionCount": 1,
      "updatedAt": "2023-08-28T09:17:44.570Z"
    }
  ],
  "nextPageToken": "945ff6de213d3ef481d028065d4c12fb996a166a3a90ef98564318decfae50ce4b36d74b7e9d9bafa6e1d169"
}

  curl --request GET -L \
    --url https://core.us.stedi.com/2023-08-01/executions \
    --header "Authorization: ${STEDI_API_KEY}" 

{
  "items": [
    {
      "createdAt": "2023-08-28T09:00:24.965Z",
      "direction": "OUTBOUND",
      "executionId": "f75168e4-e682-4410-bfec-b5b1541c7f21",
      "faultCount": 0,
      "partnershipId": "i-am-another-merch_this-is-me",
      "source": {
        "name": "my-execution-file.edi"
      },
      "retryable": true,
      "status": "COMPLETED",
      "transactionCount": 1,
      "updatedAt": "2023-08-28T09:00:28.741Z"
    },
    {
      "createdAt": "2023-08-28T09:17:38.591Z",
      "direction": "OUTBOUND",
      "executionId": "1bdbfae4-b30e-cab8-d90f-6fd61ef3d1da",
      "faultCount": 0,
      "partnershipId": "i-am-another-merch_this-is-me",
      "source": {
        "name": "my-execution-file.edi"
      },
      "retryable": true,
      "status": "COMPLETED",
      "transactionCount": 1,
      "updatedAt": "2023-08-28T09:17:44.570Z"
    }
  ],
  "nextPageToken": "945ff6de213d3ef481d028065d4c12fb996a166a3a90ef98564318decfae50ce4b36d74b7e9d9bafa6e1d169"
}

Authorizations

Authorization

string

header

required

A Stedi API Key for authentication.

Query Parameters

pageSize

number

The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.

Required range: x > 1

pageToken

string

An opaque token returned by a previous call to this operation in the nextPageToken. If not specified, Stedi returns the first page of results.

Required string length: 1 - 1024

Response

200

application/json

ListExecutions 200 response

items

object[]

required

items.createdAt

string

required

items.updatedAt

string

required

items.executionId

string

required

items.status

enum<string>

required

Available options:

COMPLETED,

PARTIALLY_COMPLETED,

FAILED,

IGNORED,

IN_PROGRESS,

RETRYING,

RETRIED,

STARTED

items.direction

enum<string>

required

Available options:

INBOUND,

OUTBOUND,

UNKNOWN

items.transactionCount

number

items.faultCount

number

items.faultCode

enum<string>

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

items.faultMessage

string

items.fileType

enum<string>

Available options:

CSV,

EDI/EDIFACT,

FILEPART,

JSON,

PSV,

JSON/STEDI-GUIDE,

TSV,

UNKNOWN,

EDI/X12,

XML,

ZIP

items.retryable

boolean

items.parentExecutionId

string

items.childExecutionId

string

items.partnershipId

string

Identifier chosen by the user to uniquely identify a partnership.

Required string length: 1 - 81

items.connectionType

enum<string>

Available options:

bucket,

remote-ftp,

stedi-ftp,

as2

items.connectionId

string

Autogenerated identifier for a connection

items.source

object

items.operation

string

nextPageToken

string

The token used for pagination

Required string length: 1 - 1024

Was this page helpful?

Outbound interchange Poll executions

  curl --request GET -L \
    --url https://core.us.stedi.com/2023-08-01/executions \
    --header "Authorization: ${STEDI_API_KEY}" 

{
  "items": [
    {
      "createdAt": "2023-08-28T09:00:24.965Z",
      "direction": "OUTBOUND",
      "executionId": "f75168e4-e682-4410-bfec-b5b1541c7f21",
      "faultCount": 0,
      "partnershipId": "i-am-another-merch_this-is-me",
      "source": {
        "name": "my-execution-file.edi"
      },
      "retryable": true,
      "status": "COMPLETED",
      "transactionCount": 1,
      "updatedAt": "2023-08-28T09:00:28.741Z"
    },
    {
      "createdAt": "2023-08-28T09:17:38.591Z",
      "direction": "OUTBOUND",
      "executionId": "1bdbfae4-b30e-cab8-d90f-6fd61ef3d1da",
      "faultCount": 0,
      "partnershipId": "i-am-another-merch_this-is-me",
      "source": {
        "name": "my-execution-file.edi"
      },
      "retryable": true,
      "status": "COMPLETED",
      "transactionCount": 1,
      "updatedAt": "2023-08-28T09:17:44.570Z"
    }
  ],
  "nextPageToken": "945ff6de213d3ef481d028065d4c12fb996a166a3a90ef98564318decfae50ce4b36d74b7e9d9bafa6e1d169"
}

Healthcare

EDI platform

List Executions

Authorizations

Query Parameters

Response