Get Execution Metadata

Fetch a file execution's metadata document.

GET /executions/{executionId}/metadata

This endpoint retrieves a file execution's metadata document.

There are no size restrictions on documents when fetching from this endpoint.

Response

This endpoint returns a 302 Temporary redirect to the document download URL. Many HTTP clients will automatically follow this redirect, or have a simple follow redirects configuration to set. For example, using the -L or --location flag in cURL will automatically follow the redirect. In this case, the response will contain the full metadata document.

In the event you cannot, or chose not to automatically follow the redirect, the body of the response contains a JSON object with a single key documentDownloadUrl which contains a temporary URL to download the document. This URL is available for 60 minutes.

Example

The following is an example of the metadata document for a 277CA claim acknowledgment:

Authorizations

Authorization · string · required · header

A Stedi API Key for authentication.

Path Parameters

executionId · string

A unique identifier 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 app.

Response

application/json

GetExecutionMetadataDocument 302 response

documentDownloadUrl · string

A URL to download the document. This URL is available for 60 minutes.

cURL

curl --request GET \
  --url "https://core.us.stedi.com/2023-08-01/executions/{executionId}/metadata" \
  --header "Authorization: <api_key>"

JavaScript

fetch("https://core.us.stedi.com/2023-08-01/executions/{executionId}/metadata", {
  headers: {
    "Authorization": "<api_key>"
  }
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://core.us.stedi.com/2023-08-01/executions/{executionId}/metadata"

  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))
}

Python

import requests

url = "https://core.us.stedi.com/2023-08-01/executions/{executionId}/metadata"

response = requests.request("GET", url, headers = {
  "Authorization": "<api_key>"
})

print(response.text)

Java

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/executions/{executionId}/metadata"))
  .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();
}

302

{
  "documentDownloadUrl": "https://stedi-default-core-artifacts.s3.us-east-1.amazonaws.com/06bdccdc-baa1-baa1-b111..."
}

400

{
  "message": "string"
}

401

{
  "message": "string",
  "code": "string"
}

403

{
  "message": "string",
  "code": "string"
}

404

{
  "message": "string",
  "code": "string"
}

429

{
  "message": "string",
  "code": "string"
}

500

{
  "message": "string",
  "cause": {
    "name": "string",
    "message": "string",
    "stack": "string"
  }
}

503

{
  "message": "string",
  "code": "string"
}

504

{
  "message": "string",
  "code": "string"
}