Reference-Data API

Overview

With the Reference-Data API, a client can interact with and query existing custom data tables, and have the abilty to:

  • Retrieve lists of custom data tables
  • Retrieve all entries from a custom data table
  • Retrieve entries from a custom data table based on specified criteria. Note: primary key must be defined for custom data table
  • Append entries to a custom data table

Reference-Data API consists of the following calls:

  • GET reference-data: Returns an array of available reference-data datasets, and summary information about each dataset.

  • GET /reference-data/{dataset}: Returns summary information about the specified dataset.

  • GET reference-data/{dataset}/records: Returns specified data loaded from other processes for targeting and personalization.

  • GET /reference-data/{dataset}/records/{id}: Returns specified data loaded from other processes for targeting and personalization.

  • GET reference-data/{dataset}?view=schema: Returns the attributes that are available in the custom data table arrays for the specified Api-User.

  • PUT /reference-data/{dataset}/records/{id}: Adds to or modifies specified data loaded from other processes for targeting and personalization.

  • POST reference-data/{dataset}/records/import: Inserts or updates data associated with specified key values.

  • POST reference-data/{dataset}/records/file-import: Inserts or updates large amounts of data from a flat file.

  • DELETE /reference-data/{dataset}/records/{recordid}: Deletes reference data associated with the specified {recordid} from a specified {dataset}.