File execution

Poll Executions

This endpoint is used to regularly poll for new executions that have been processed by Stedi.

You must define one of startDateTime or pageToken when making a request.

You may optionally define a pageSize. The minimum pageSize is 1, and the maximum pageSize is 1000. The default is 100.

startDateTime takes a string in ISO 8601 format. (ex: 2023-08-10T18:00:00Z). startDateTime must be set to at least 1 minute in the past.

The results will contain executions that occurred after this startDateTime. Starting from the oldest to newest executions ordered by the processedAt field. Note, this is exclusive of the startDateTime, a execution occuring at exactly 2023-08-10T18:00:00Z for instance, would not be included. In addition, there is a 15 second window where newly created executions will not be included to account for any network latency or clock drifts within the systems to ensure you do not miss any executions.

Each request will always return a nextPageToken, regardless of whether there are new executions or not.

We DO NOT recommend trying to roll your own polling strategy leveraging startDateTime only. There are edge cases around two executions occuring at the exact same time and being on the edge of a pagination which could cause you to miss one due to the exclusive nature of startDateTime. We recommend using pageToken’s instead.

When making subsequent polling requests (not initiating with startDateTime), the pageToken can be used to continue iterating through pages of executions. Usage of the pageToken guaruntees you will not miss any executions on the stream. If at any point there are no more new executions in the item array, you will still receive a nextPageToken. Continue to use this token to poll for new executions. Once there are new executions, they will be returned in the item array.

pageToken’s you have retrieved can serve as checkpoints. They do not expire, and you can always start from that point in the execution stream again if you need to catch a system up or recover from a failure. Storing pageToken’s as part of your polling process is encouraged.

pageToken’s are unique per request, opaque, and should not be parsed or modified in any way. They are not guaranteed to be in any particular format, and may change in the future.

GET

polling

executions

curl --request GET \
  --url https://core.us.stedi.com/2023-08-01/polling/executions \
  --header 'Authorization: <api-key>'

{
  "nextPageToken": "<string>",
  "items": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "executionId": "<string>",
      "status": "COMPLETED",
      "direction": "INBOUND",
      "transactionCount": 123,
      "faultCount": 123,
      "faultCode": "DELIVERY_FAILURE",
      "faultMessage": "<string>",
      "fileType": "CSV",
      "retryable": true,
      "parentExecutionId": "<string>",
      "childExecutionId": "<string>",
      "partnershipId": "<string>",
      "connectionType": "bucket",
      "connectionId": "<string>",
      "source": {
        "dirname": "<string>",
        "name": "<string>"
      },
      "operation": "<string>"
    }
  ]
}

This endpoint returns file executions that Stedi processed after the specified startDateTime.

Executions are ordered from oldest to newest according to the processedAt property. This is exclusive of the startDateTime. For example, if the provided startDateTime is 2023-08-10T18:00:00Z, an execution processed at exactly that time would not be included in the results. There is also a fifteen-second window where newly created executions are excluded, meaning Stedi returns results up to fifteen seconds before the time of your request. This functionality accounts for any network latency or clock drift within the systems to ensure you don’t miss any executions.

Polling with page tokens

We don’t recommend polling using startDateTime only. Due to the exclusive nature of startDateTime, you could potentially miss an execution if two executions occur at the exact same time and are on the edge of a pagination. Instead, you should use pageToken.

After the initial request, you can poll again immediately using pageToken to continue iterating through the pages of executions. The endpoint always returns a nextPageToken, regardless of whether additional executions match the request criteria. If the items array is empty, continue using the provided nextPageToken to poll for new executions. New executions will be returned when available.

We recommend storing pageToken values as part of your polling process. They don’t expire, allowing you to start from that point in the execution stream again if you need to catch a system up to date or recover from a failure.

Note that pageToken values are unique per request, opaque, and shouldn’t be parsed or modified in any way. They are not guaranteed to be in any particular format, and may change in the future.

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

A 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

startDateTime

string

An ISO 8601 formatted string. For example 2023-08-28T00:00:00Z. Stedi returns executions processed after this time.

Response

200

application/json

ListPollingExecutions 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

List executions List execution transactions

curl --request GET \
  --url https://core.us.stedi.com/2023-08-01/polling/executions \
  --header 'Authorization: <api-key>'

{
  "nextPageToken": "<string>",
  "items": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "executionId": "<string>",
      "status": "COMPLETED",
      "direction": "INBOUND",
      "transactionCount": 123,
      "faultCount": 123,
      "faultCode": "DELIVERY_FAILURE",
      "faultMessage": "<string>",
      "fileType": "CSV",
      "retryable": true,
      "parentExecutionId": "<string>",
      "childExecutionId": "<string>",
      "partnershipId": "<string>",
      "connectionType": "bucket",
      "connectionId": "<string>",
      "source": {
        "dirname": "<string>",
        "name": "<string>"
      },
      "operation": "<string>"
    }
  ]
}

Payers & enrollment

Eligibility & benefits

Claims processing

EDI platform

Poll Executions

Polling with page tokens

Authorizations

Query Parameters

Response

Payers & enrollment

Eligibility & benefits

Claims processing

EDI platform

​Polling with page tokens

Authorizations

Query Parameters

Response

Polling with page tokens