Poll Executions
Poll for new file executions that Stedi has recently processed.
/polling/executionsThis 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.
A Stedi API Key for authentication.
Query Parameters
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.
- Range:
≥ 1
A token returned by a previous call to this operation in the nextPageToken. If not specified, Stedi returns the first page of results.
You must supply either this property or startDateTime in every request.
- Required string length:
1 - 1024
An ISO 8601 formatted string. For example 2023-08-28T00:00:00Z. Stedi returns executions processed after this time.
You must supply either this property or pageToken in every request. The startDateTime must be at least one minute in the past.
- Format:
date-time
Response
ListPollingExecutions 200 response
Token for pagination to retrieve the next page of results; null if there are no more results
- Required string length:
1 - 1024
The processed executions that match the request criteria. The items array is empty if there are no matching executions.
curl --request GET \
--url "https://core.us.stedi.com/2023-08-01/polling/executions?pageSize=200" \
--header "Authorization: <api_key>"fetch("https://core.us.stedi.com/2023-08-01/polling/executions?pageSize=200", {
headers: {
"Authorization": "<api_key>"
}
})package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://core.us.stedi.com/2023-08-01/polling/executions?pageSize=200"
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/polling/executions?pageSize=200"
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/polling/executions?pageSize=200"))
.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"
}