skip to main content
Hybrid Data Pipeline API reference : Management API : Data Sources API
  

Try Now

Data Sources API

Hybrid Data Pipeline enables access to a variety of data stores, such as Apache Hive, DB2, SQL Server, Oracle, and Salesforce. To access data residing on a backend data store, administrators or users must create a Hybrid Data Pipeline data source. A Hybrid Data Pipeline data source can be created by specifying parameters associated with a specific data store. The information provided in the data source allows the service to connect to the backend data store. A data source can be created with the Web UI or the Data Sources API.
Foremost, the Data Sources API enables users to create data sources. A user must have the CreateDataSource (1) permission to create a data source. When a user creates a data source, he or she is the owner of the data source. In turn, data source owners can view, modify, delete, and share the data sources they own, if they have the corresponding permissions for these operations. For example, a data source owner must have the ViewDataSource (2) permission to view the data source, and the ModifyDataSource (3) permission to modify the data source.
Note: The Schema API and the Driver Files API are extensions of the Data Sources API. The Schema API can be used to retrieve the information needed to configure a schema for OData connectivity. The Driver Files API can be used to retrieve and manage files used to support data connectivity to non-relational data stores and REST services.
The Data Sources API also supports advanced functionality that allows data source owners to share data sources with other users and enables administrators to create and manage data sources on behalf of users. See the following topics for more information.
*Sharing data sources
*Managing resources on behalf of users
The following table lists the operations that can be performed using the Data Sources API.
Task
Request
URL
GET
https://<myserver>:<port>/api/mgmt/datastores
GET
https://<myserver>:<port>/api/mgmt/datastores/{datastoreId}
POST
https://<myserver>:<port>/api/mgmt/datasources
GET
https://<myserver>:<port>/api/mgmt/datasources
GET
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}
PUT
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}
DELETE
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}
GET
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/permissions
PUT
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/permissions
POST
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/test
POST
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/map
POST
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/model
GET
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/model
GET
https://<myserver>:<port>/api/mgmt/datasources/{groupDatasourceId}/members
POST
https://<myserver>:<port>/api/mgmt/datasources/{groupDatasourceId}/members
POST
https://<myserver>:<port>/api/mgmt/datasources/{groupDatasourceId}/members
DELETE
https://<myserver>:<port>/api/mgmt/datasources​/{groupDatasourceId}/members/{memberDatasourceId}
GET
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedUsers
POST
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedUsers
DELETE
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedUsers
GET
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedUsers/{userId}
PUT
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedUsers/{userId}
DELETE
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedUsers/{userId}
GET
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedTenants
POST
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedTenants
DELETE
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedTenants
GET
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedTenants/{tenantId}
PUT
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedTenants/{tenantId}
DELETE
https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/sharedTenants/{tenantId}
* Sharing data sources
* Managing resources on behalf of users
* Get data stores
* Get options for a data store
* Create a data source
* Get data sources
* Get data source details
* Update a data source
* Delete a data source
* Get data source permissions
* Update permissions on a data source
* Test a connection to a data source
* Refresh a data source map
* Create or refresh a data source OData model
* Check status of the OData model refresh
* Get members of a data source group
* Add member data sources to a group data source group
* Update members of a group data source
* Delete a member data source from a group data source
* Get shared data source users
* Share data source with a user or users
* Delete shared users from the data source
* Get the data source permissions for a shared user
* Update data source permissions for shared user
* Delete shared user from a data source
* Get shared data source tenants
* Share data source with a tenant or tenants
* Delete shared tenants from a data source
* Get the data source permissions for a shared tenant
* Update data source permissions for shared tenant
* Delete shared tenant from a data source