Skip to content

API for AWS B2B Data Interchange

ABAP Package /AWS1/API_BDI_IMPL
ABAP SDK "TLA" BDI
ABAP Interface /AWS1/IF_BDI

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for AWS B2B Data Interchange is BDI. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the b2bi module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

This is the Amazon Web Services B2B Data Interchange API Reference. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.

B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12.

Rather than actually running a command, you can use the --generate-cli-skeleton parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see Generate and use a parameter skeleton file.

Using the SDK

In your code, create a client using the SDK module for AWS B2B Data Interchange, which is created with factory method /AWS1/CL_BDI_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_bdi)       = /aws1/cl_bdi_factory=>create( go_session ).

Your variable go_bdi is an instance of /AWS1/IF_BDI, and all of the operations in the AWS B2B Data Interchange service are accessed by calling methods in /AWS1/IF_BDI.

API Operations

For an overview of ABAP method calls corresponding to API operations in AWS B2B Data Interchange, see the Operation List.

Factory Method

/AWS1/CL_BDI_FACTORY=>create( )

Creates an object of type /AWS1/IF_BDI.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL /AWS1/RT_PROTOCOL

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE /AWS1/CL_RT_SESSION_BASE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

IV_REGION TYPE /AWS1/RT_REGION_ID /AWS1/RT_REGION_ID

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT /AWS1/RT_ENDPOINT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_BDI /AWS1/IF_BDI

/AWS1/IF_BDI represents the ABAP client for the b2bi service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_bdi)->get_config( ).

lo_config is a variable of type /AWS1/CL_BDI_CONFIG. See the documentation for /AWS1/CL_BDI_CONFIG for details on the settings that can be configured.

Paginators

Paginators for AWS B2B Data Interchange can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_BDI_PAGINATOR`](./_AWS1_IF_BDI_PAGINATOR.md). The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using `has_next()` and `get_next()` methods.

Details about the paginator methods available for service AWS B2B Data Interchange can be found in interface [`/AWS1/IF_BDI_PAGINATOR`](./_AWS1_IF_BDI_PAGINATOR.md).