Data Source API version 2 overview

Data Source API v2 overview

The Data Source API v2 is a HTTP REST API used by hosts (desktop clients or servers) external to the Workforce Optimization (WFO) system. These hosts use the API to create, delete, or get information about data sources.

The Data Source API resides on the server that hosts the EM Core server role and is exposed by the Enterprise Manager application.

The Data Source API log is in the Enterprise Manager log files.

The Data Source API v2 supports access and configuration of the following:

  • Data Source: type TextAnalytics

    You can create two sub-types of a TextAnalytics data source: a Text Store sub-type and a Text Project sub-type. The Text Store data source sub-type represents an isolated store of the Text project's data that is assigned to a tenant. The Text Project data source represents sets of interactions. You create a Text Project data source under the Text Store data source of the tenant.

  • Update or Delete a data source

    You can use requests in the v2 API to update an existing data source or delete a data source.

  • Get requests

    The v2 API includes several Get requests. You can get a data source by name, orgID, type, subtype, or data source ID. You can also get a list of data ports created for a data source.

Authentication

Required headers

Common URL components in Data Source API v2

Data Sources API v2 requests and error codes

Data Source API v2 Definitions