Loading...

View Data Sources and Properties in Data Cube (REST API: GET)

This operation returns a list of all the data sources in Data Cube and their properties.

Request

Syntax

GET <webservice>/dcube/GetDataSources?datasourceId={datasourceId}&type={datasourcetype}&summary={summary} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

datasourceId

The data source ID for a particular data source.

You can enter a data source ID to retrieve information about a specific data source. To get a list of data source IDs, use the view data sources API without optional parameters.

No

datasourcetype

The type of data source. You can enter a data source type to retrieve information about data sources of a specific type.

Valid values are:

  • 1: Database
  • 2: Web site
  • 3: CSV
  • 4: File system
  • 5: NAS
  • 8: Salesforce
  • 9: LDAP
  • 10: Federated Search
  • 11: Open data source
  • 12: HTTP

No

summary

The type of information that is returned for the data sources.

Valid values are:

  • 0: Return all data source properties
  • 1: Return only summary information

No

Request Headers

Name

Description

Host

The host name of the Web Server or the Web Console that is used in the API request.

Accept

The format of the response.

Valid value is: application/xml.

Authtoken

The authentication token that is received after you log on.

For more information about receiving an authentication token, see Authentication.

Examples

Sample Request

GET <webservice>/dcube/GetDataSources?datasourceId=4395 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<DM2ContentIndexing_GetCollectionsResp>
  <collections clientId="2075" computedCoreName="DC_blank_datasource1_4426" description="" coreName="datasource1" cloudId="76" ownerUserId="73" schemaType="default" createUTCTime="1479386684" coreId="4426" attribute="0">
    <datasources ownerType="1" datasourceGuid="56E5BB6C-A698-4E21-838A-34E5A5DFFCE0" description="" userId="73" datasourceType="11" zkQuorum="ANALYTICSENGINE:2181" datasourceId="4395" createUTCTime="1479386685" attribute="0" datasourceName="datasource1" modifiedByUserId="73" modifiedUTCTime="1479386686" />
  </collections>
</DM2ContentIndexing_GetCollectionsResp>

Last modified: 4/9/2019 1:54:34 PM