Api Overview

Last updated: Sep 25, 2024

ONESOURCE Data Hub Blueprint API

ONESOURCE Data Hub Blueprint APIs enable the definition of the data elements and data type that are used during the data processing for validation and classification in Data Hub.
  • Data management
  • Data validation

Overview

ONESOURCE Data Hub Blueprint APIs enable the definition of the data elements and data type that are used during the data processing for validation and classification in Data Hub.

ONESOURCE Data Hub API Capability Areas

ONESOURCE Data Hub provides APIs for all actions available in the front and backend of the product and are documented in six areas based on function:

  • Blueprint
  • Template (Schematic)
  • Ingest
  • Topic
  • Collection
  • Query

The interrelationship between the ONESOURCE Data Hub function area APIs exists and IDs from one area are used in other areas. Data fields defined in the Blueprint is used to define processing in the Template (Schematic). Ingest uploads data that can be processed into a Topic by applying a Template (Schematic).

A Blueprint establishes how a Collection data structure is defined and determines which Topics can be added to the Collection. Once a Collection is published the resulting data is available with Query including aggregated data via Custom Views established in the Blueprint. Side by side data comparisons & data downloads are available in Topic and Collection.

Related APIs

ONESOURCE Administration
Authorization for ONESOURCE API

Guidelines to perform actions, such as creating app and user, generating a token and making a call, with Autorization API

ONESOURCE Data Hub
ONESOURCE Data Hub Ingest API

ONESOURCE Data Hub Ingest APIs are used for uploading data from various types of files and/ or integrations.

ONESOURCE Data Hub
ONESOURCE Data Hub Query API

ONESOURCE Data Hub Query APIs enable the access to information contained in or about a Collections that have been Published in Data Hub.

ONESOURCE Data Hub
ONESOURCE Data Hub Collection API

ONESOURCE Data Hub Collection APIs enable the management of Topics to group them in Collections in Data Hub.

ONESOURCE Data Hub
ONESOURCE Data Hub Processing Service API

ONESOURCE Data Hub Processing APIs allows management of processing the ingested data.

ONESOURCE Data Hub
ONESOURCE Data Hub Topic API

ONESOURCE Data Hub Topic APIs provide access to the Topics which are sets of data records that arrived via file ingest or via other streaming methods that have been processed in Data Hub

ONESOURCE Data Hub
ONESOURCE Data Hub Schematic/Template API