Data Export API - Object Based Data Replication

This feature provides a number of enhances to the Data Export API to better support your Data Lake and reporting requirements.  Specific changes include:

  1. Support for exporting by object (vs table by table)  - with this option the Data Export API will export the parent object and the parent's related child information.
  1. The option to export the data into a single JSON file has been added.
  1. On the External System the HTTP Method drop down now includes the PUT method - previously the httpMethod PUT had to include in the request itself, now you only need to specify the PUT HTTP Method on the External System setup.

Support for Export by Object

In the example below, the Data Export API has been run on an object basis, in this case, a shipment object, note that the parent object and the related child objects are provided.

Shipment Object Data Export API Example

Shipment Object Data Export API Example

Export Data to a Single JSON File

In the example below, the same shipment object exported above was exported, but in this case the JSON file format was selected.  The extract in this scenario provides a single file in a JSON file format.

JSON File Format Export - Single File

JSON File Format Export - Single File

External System the HTTP Method Includes the PUT Method

In the image below the new option for the External System HTTP Method of PUT is highlighted.  Previously, the httpMethod PUT had to include in the request itself, with the addition of the HTTP Method of PUT in the drop down, you only need to specify the PUT HTTP Method on the External System setup.

External System - HTTP Method PUT Added

External System - HTTP Method PUT Added

Business Benefit

The option to perform the data export by object vs table by table, will simplify the effort required for exporting data using the Data Export API.

Steps to Enable

You don't need to do anything to enable this feature.

Tips And Considerations

When exporting by object, if there is no records in the child table then that table will not be included in the export for the parent object.

If there are more than 1,000 objects in the export, the export will be done in batches of 1,000 records, so the first set of 1,000 and related child tables will be in the first batch with the CSV files ending with "_1" then the next batch of CSV files ending with "_2" etc.

Key Resources

  • For more complete information about the Data Export API - please see the REST API for Fusion Cloud Transportation and Global Trade Management Data Export section of the REST documentation.