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 production 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

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.

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.

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.

x12 · Object

Details about the X12 EDI transaction.

Request

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

Response

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