Help

Dictionaries

The Consumer REST API provides access to a number of data sets. Each data set is described by a dictionary. Dictionaries consist of fields which are grouped in types.

The following types are distinguised:

• web_assetEntities — represent records which are uniquely identified by a field called 'id'.
• ballotStructs — represent records which can be only retrieved as a part of an entity record.

Services

For each dictionary, one or more of the following services are available:

• linklatest— provides the latest record for an entity based on the id field.
• timelinetimeseries— provides historical updates for an entity based on the id field.
• speaker_phonestream— provides all updates to a data set in a fixed order.
• camera_rollsnapshots— provides historical point-in-time data set snapshots for predefined snap times.
• next_weekbatchruns— provides updates from specific batchrun for an entity based on batchrun id.
• attachmentattachments— provides attachments downloads.

Short-cuts

• f— to put focus on the filter input (if available).
• enter— to select first link from the filter input.
• alt-PageUp— to move up one bread crumb.
• s— to select the first 'stream' link on page.
• l— to select the first 'latest' link on page.
• t— to select the first 'timeseries' link on page.

Support

Questions and help can be requested from the following email address: support@ihsmarkit.com

Consumer API Version

Version 6.13.6