Data Source APIs Data Source Wizard Resource

This service allows for listing, downloading, and removal of DSW data sources in the BA Platform.

Get list of DSW datasource IDs

get

Get a list of Data Source Wizard (DSW) datasource ids.

Example Request:

GET pentaho/plugin/data-access/api/datasource/dsw/domain

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic Authentication

Responses

200

Successfully retrieved the list of DSW IDs

application/xmlapplication/json

objectOptional

List of DSW IDs in XML format

get

/data-access/api/datasource/dsw/domain

HTTPcURLJavaScriptPython

GET /data-access/api/datasource/dsw/domain HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Successfully retrieved the list of DSW IDs

<jaxbList>
  <type>java.lang.String</type>
  <item>jmeter-dsw-pentaho-test.xmi</item>
  <item>sample-dsw-data.xmi</item>
</jaxbList>

Export DSW data source

get

Export the DSW data source for the given DSW ID. The response will be zipped if there is more than one file. The response will contain an XMI and/or a mondrian cube definition file.

Example Request:

GET pentaho/plugin/data-access/api/datasource/dsw/domain/jmeter-dsw-pentaho-test.xmi

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic Authentication

Path parameters

dswIdstringRequired

The id of the DSW datasource to export

Responses

200

DSW datasource export succeeded

application/octet-stream

string · binaryOptional

An encrypted .XMI file or a .zip with encoded .XMI files

401

User is not authorized to export DSW datasource

text/plain

500

Failure to export DSW datasource

text/plain

get

/data-access/api/datasource/dsw/domain/{dswId}

HTTPcURLJavaScriptPython

GET /data-access/api/datasource/dsw/domain/{dswId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

binary

Remove DSW data source

delete

Remove the DSW data source for a given DSW ID.

Example Request:

DELETE pentaho/plugin/data-access/api/datasource/dsw/domain/jmeter-dsw-pentaho-test.xmi

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic Authentication

Path parameters

dswIdstringRequired

The id of the DSW datasource to remove

Responses

200

Successfully removed the DSW data source

text/plain

stringOptional

Success message

401

User is not authorized to delete the DSW datasource

text/plain

500

Failure to remove DSW data source

text/plain

delete

/data-access/api/datasource/dsw/domain/{dswId}

HTTPcURLJavaScriptPython

DELETE /data-access/api/datasource/dsw/domain/{dswId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

text