GET
/
transactions
/
{transactionId}
/
fragments
/
{fragmentIndex}
curl --request GET \
  --url https://core.us.stedi.com/2023-08-01/transactions/{transactionId}/fragments/{fragmentIndex} \
  --header 'Authorization: <api-key>'
{
  "transactionId": "<string>",
  "fileExecutionId": "<string>",
  "direction": "INBOUND",
  "mode": "test",
  "processedAt": "2023-11-07T05:31:56Z",
  "fragmentIndex": 123,
  "fragments": {
    "keyName": "<string>",
    "fragmentCount": 123,
    "batchSize": 123
  },
  "transactionUrl": "<string>",
  "artifacts": [
    {
      "artifactType": "text/csv",
      "usage": "attachment",
      "sizeBytes": 123,
      "url": "<string>",
      "model": "execution"
    }
  ],
  "partnership": {
    "partnershipId": "<string>",
    "partnershipType": "x12",
    "sender": {
      "profileId": "<string>"
    },
    "receiver": {
      "profileId": "<string>"
    }
  },
  "x12": {
    "metadata": {
      "interchange": {
        "acknowledgmentRequestedCode": "<string>",
        "controlNumber": 499999999.5
      },
      "functionalGroup": {
        "controlNumber": 499999999.5,
        "date": "<string>",
        "functionalIdentifierCode": "<string>",
        "time": "<string>",
        "release": "<string>"
      },
      "transaction": {
        "controlNumber": "<string>",
        "transactionSetIdentifier": "<string>"
      },
      "sender": {
        "applicationCode": "<string>",
        "isa": {
          "qualifier": "<string>",
          "id": "<string>"
        }
      },
      "receiver": {
        "applicationCode": "<string>",
        "isa": {
          "qualifier": "<string>",
          "id": "<string>"
        }
      }
    },
    "transactionSetting": {
      "guideId": "<string>",
      "transactionSettingId": "<string>"
    }
  }
}

This endpoint retrieves metadata about a specific fragment within a transaction. To retrieve the fragment itself, use the Get 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
string
header
required

A Stedi API Key for authentication.

Path Parameters

​
transactionId
string
required

A unique identifier for the processed transaction within Stedi. This ID is included in the transaction.processed.v2 event, or you can retrieve it manually from the transaction's details page within the Stedi app.

​
fragmentIndex
number
required

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

Response

200
application/json
GetTransactionFragment 200 response
​
transactionId
string
required

A unique identifier for the processed transaction within Stedi. This ID is included in the transaction.processed.v2 event, or you can retrieve it manually from the transaction's details page within the Stedi app.

​
fileExecutionId
string
required
​
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND,
UNKNOWN
​
mode
enum<string>
required
Available options:
test,
production,
other
​
processedAt
string
required
​
fragmentIndex
number
required
​
fragments
object
required
​
transactionUrl
string
required
​
artifacts
object[]
required
​
partnership
object
required
​
x12
object