Retrieve Fragment

Retrieve metadata for a fragment.

GET /transactions/{transactionId}/fragments/{fragmentIndex}

This endpoint retrieves metadata about a specific fragment within a transaction. To retrieve the fragment itself, use the Retrieve Fragment Output endpoint.

Fragments allow you to split large transactions into smaller chunks for easier processing. You can enable fragments for one repeated EDI segment in each transaction set and then split the transaction into chunks based on that segment.

Authorizations

Authorization · Required Header

A Stedi API Key for authentication.

Path Parameters

transactionId · String

A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal.

fragmentIndex · Number

The identifier for a specific fragment within a processed transaction. This ID is included in the fragment processed event, or you can retrieve it manually from the transaction's details page within the Stedi portal.

Response

application/json

GetTransactionFragment 200 response

transactionId · String Required

A unique identifier for the processed transaction containing this fragment. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal.

fileExecutionId · String Required

A unique identifier for the processed file containing this fragment. This ID is included in the file processed event. You can also retrieve it manually from the file's details page in the Stedi portal.

direction · String Required

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.

Possible values

INBOUND

OUTBOUND

UNKNOWN

mode · String Required

Indicates whether the transaction contains test or production data. Stedi determines this from the value in ISA15 Usage Indicator Code.

Possible values

test

production

other

processedAt · String Required Format: date-time

The date and time when Stedi processed the transaction containing the fragment, in ISO 8601 format. For example, 2023-08-28T00:00:00Z.

fragmentIndex · Number Required

The identifier for the fragment within a processed transaction.

fragments · Object Required

Details about fragments included in the transaction, if applicable. Fragments break large transactions into smaller parts for easier processing and management.

keyName · fragments.keyName · String Required

The JSON schema key name for the segment in the Stedi guide used to split the transaction into fragments. For example, in an 834 Health Care Benefit Enrollment and Maintenance, this would be member_level_detail_INS_loop.

fragmentCount · fragments.fragmentCount · Number Required

The total number of fragments in the transaction.

batchSize · fragments.batchSize · Number Required

The maximum size of each fragment in kilobytes (KB). Stedi uses this to automatically split large inbound transactions into fragments.

transactionUrl · String Required

The URL to review the transaction within the Stedi portal.

artifacts · Array of Objects Required

A list of artifacts related to the transaction containing the fragment.

artifactType · artifacts[].artifactType · String Required

The format of the artifact.

Possible values

text/csv

application/edifact

application/filepart

application/json

application/pdf

usage · artifacts[].usage · String Required

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.

For 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.

Possible values

attachment

input

metadata

output

sizeBytes · artifacts[].sizeBytes · Number Required

The size of the artifact in bytes.

url · artifacts[].url · String Required

A URL to download the artifact.

model · artifacts[].model · String Required

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.

Possible values

execution

fragment

transaction

fault

partnership · Object Required

Information about the associated partnership.

A 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. If you're sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnership for you automatically when you set up your account.

partnershipId · partnership.partnershipId · String Required Regex pattern: ^([a-zA-Z0-9._-]+)$ Length: 1 - 81

The unique identifier for the partnership within the Stedi platform.

A 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. If you're sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnerships for you automatically when you set up your account.

partnershipType · partnership.partnershipType · String Required

The type of partnership, which determines the EDI standard used for exchanging transactions.

Possible values

x12

edifact

sender · partnership.sender · Object Required

The entity that initiated the transaction.

profileId · partnership.sender.profileId · String Required Regex pattern: ^([a-zA-Z0-9._-]+)$ Length: 1 - 40

A unique identifier for the profile within the Stedi platform.

receiver · partnership.receiver · Object Required

The entity that is receiving the transaction.

profileId · partnership.receiver.profileId · String Required Regex pattern: ^([a-zA-Z0-9._-]+)$ Length: 1 - 40

A unique identifier for the profile within the Stedi platform.

x12 · Object

Details about the X12 EDI transaction.

metadata · x12.metadata · Object Required

Metadata about the X12 EDI transaction, including information from the interchange, functional group, and transaction headers as well as the sender and receiver IDs.

interchange · x12.metadata.interchange · Object Required

Data from the Interchange Control Header of the X12 EDI file.

acknowledgmentRequestedCode · x12.metadata.interchange.acknowledgmentRequestedCode · String Required

The value of ISA14 in the Interchange Control Header, which indicates whether the sender is requesting a TA1 Interchange Acknowledgment.

controlNumber · x12.metadata.interchange.controlNumber · Number Required Range: ≥ 0 and ≤ 999999999

The control number in the Interchange Control Header.

functionalGroup · x12.metadata.functionalGroup · Object Required

Data from the Functional Group Header of the X12 EDI file.

controlNumber · x12.metadata.functionalGroup.controlNumber · Number Required Range: ≥ 0 and ≤ 999999999

The Group Control Number (GS06).

date · x12.metadata.functionalGroup.date · String Required

The date in the Functional Group Header (GS04), formatted as YYYY-MM-DD. For example, 2023-08-28.

functionalIdentifierCode · x12.metadata.functionalGroup.functionalIdentifierCode · String Required

The Functional Identifier Code (GS01), which indicates the type of transaction. For example, HC for an 837 Healthcare Claim.

time · x12.metadata.functionalGroup.time · String Required

The Time (GS05), formatted as HH:MM:SS. For example, 21:29:57.

release · x12.metadata.functionalGroup.release · String Required

The Version/Release/Industry Identifier Code (GS08), which indicates the version of the X12 standard used. For example, 005010X222A1.

transaction · x12.metadata.transaction · Object Required

Data from the Transaction Set Header of the X12 EDI file.

controlNumber · x12.metadata.transaction.controlNumber · String Required

The Transaction Set Control Number (ST02).

transactionSetIdentifier · x12.metadata.transaction.transactionSetIdentifier · String Required

The Transaction Set Identifier Code (ST01), which indicates the type of transaction. For example, 837 for an 837 Healthcare Claim.

sender · x12.metadata.sender · Object Required

The Application Code and ISA ID for the profile.

applicationCode · x12.metadata.sender.applicationCode · String Required

The Application Code for the profile, which is used to identify the entity in the GS header of an EDI file.

isa · x12.metadata.sender.isa · Object Required

The Interchange ID and qualifier.

qualifier · x12.metadata.sender.isa.qualifier · String Required

The Interchange Sender ID Qualifier, which indicates the type of identifier. For example, ZZ for a mutually defined identifier.

id · x12.metadata.sender.isa.id · String Required

The Interchange ID, which is the unique identifier for the entity in the EDI file.

receiver · x12.metadata.receiver · Object Required

The Application Code and ISA ID for the profile.

applicationCode · x12.metadata.receiver.applicationCode · String Required

The Application Code for the profile, which is used to identify the entity in the GS header of an EDI file.

isa · x12.metadata.receiver.isa · Object Required

The Interchange ID and qualifier.

qualifier · x12.metadata.receiver.isa.qualifier · String Required

The Interchange Sender ID Qualifier, which indicates the type of identifier. For example, ZZ for a mutually defined identifier.

id · x12.metadata.receiver.isa.id · String Required

The Interchange ID, which is the unique identifier for the entity in the EDI file.

transactionSetting · x12.transactionSetting · Object

The IDs for the guide and transaction setting Stedi used to process the transaction.

guideId · x12.transactionSetting.guideId · String

The unique identifier for the Stedi guide used to process the transaction.

Stedi guides are machine-readable specifications for X12 EDI transactions. They describe how to structure and validate EDI files for each transaction type.

transactionSettingId · x12.transactionSetting.transactionSettingId · String

The unique identifier for the transaction setting Stedi used to process the transaction.

Transaction settings configure how Stedi processes specific transaction types, such as which Stedi guide to use and other processing options. If you're using the Stedi clearinghouse, Stedi automatically configures the required transaction settings for you when you set up your account.

cURL

curl --request GET \
  --url "https://core.us.stedi.com/2023-08-01/transactions/{transactionId}/fragments/{fragmentIndex}" \
  --header "Authorization: <api_key>"

JavaScript

fetch("https://core.us.stedi.com/2023-08-01/transactions/{transactionId}/fragments/{fragmentIndex}", {
  headers: {
    "Authorization": "<api_key>"
  }
})

Go

package main

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

func main() {
  url := "https://core.us.stedi.com/2023-08-01/transactions/{transactionId}/fragments/{fragmentIndex}"

  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/transactions/{transactionId}/fragments/{fragmentIndex}"

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/transactions/{transactionId}/fragments/{fragmentIndex}"))
  .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();
}

200

{
  "direction": "INBOUND",
  "mode": "production",
  "fileExecutionId": "29d6b95d-c611-bce6-b893-0e64821cd238",
  "transactionId": "7d0c6f84-4cec-4f4a-a681-e7a36eb48d25",
  "processedAt": "2023-10-12T15:34:01.435Z",
  "partnership": {
    "partnershipId": "me_another-merch",
    "partnershipType": "x12",
    "sender": {
      "profileId": "merch"
    },
    "receiver": {
      "profileId": "me"
    }
  },
  "x12": {
    "metadata": {
      "interchange": {
        "acknowledgmentRequestedCode": "0",
        "controlNumber": 103
      },
      "functionalGroup": {
        "controlNumber": 103,
        "release": "005010X220A1",
        "date": "2004-12-27",
        "time": "13:24",
        "functionalIdentifierCode": "BE"
      },
      "transaction": {
        "controlNumber": "13331",
        "transactionSetIdentifier": "846"
      },
      "receiver": {
        "applicationCode": "THISISME",
        "isa": {
          "qualifier": "02",
          "id": "THISISME"
        }
      },
      "sender": {
        "applicationCode": "ANOTHERMERCH",
        "isa": {
          "qualifier": "02",
          "id": "ANOTHERMERCH"
        }
      }
    },
    "transactionSetting": {
      "guideId": "01HAPYY1YPFWGVJH1HD75SP0A2",
      "transactionSettingId": "01HCAHP7PY84DBZG0FM5JB4MCE"
    }
  },
  "fragments": {
    "batchSize": 800,
    "keyName": "item_identification_LIN_loop",
    "fragmentCount": 1065
  },
  "fragmentIndex": 0,
  "artifacts": [
    {
      "artifactType": "application/json",
      "sizeBytes": 389388,
      "model": "fragment",
      "usage": "output",
      "url": "https://core.us.stedi.com/2023-08-01/transactions/7d0c6f84-4cec-4f4a-a681-e7a36eb48d25/fragments/0/output"
    }
  ],
  "transactionUrl": "https://core.us.stedi.com/2023-08-01/transactions/7d0c6f84-4cec-4f4a-a681-e7a36eb48d25"
}

400

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

401

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

403

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

404

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

409

{
  "message": "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"
}