Use Cases

Use cases demonstrate how to get things done with REST APIs, including how to create export requests, retrieve statuses, and more. Use them to understand quickly how REST APIs can meet your business needs.

To get the most benefit from the following use cases, you should be familiar with basic REST concepts discussed in the Quick Start. See also Content Management for more information on possible options.

Use Case	Shows how to...
Export Multiple Tables for a Date Range	Submit an Export Request for two tables, selecting records inserted or updated between two dates.
Synchronous Export of Compressed Content	Export rows from a single table and return CSV data immediately. The data will be returned as GZIP compressed data.
Cancel Request	Stop a request that is currently running.
Export Table Using Saved Query	Submit an Export Request for the SHIPMENT tables, selecting records based on a pre-existing Saved Query using bind variables within the request to export shipments in a given status.
Export Content and Deleted PKs	Submit an Export Request for records from the SHIPMENT table which have been modified within a given date range and any deleted PKs within the same date range.