Data Source API

{
  "data_sources": [
    { "id": 12, "name": "Sales MySQL", "type": "database", "plugin_name": "" },
    { "id": 18, "name": "Tableau Server", "type": "plugin", "plugin_name": "Tableau" }
  ]
}

A GET request to /api/data_source_sql returns the SQL Data Sources and their connection settings.

1. Item: data_source_sql
2. Method: GET
3. Enter an API Token.
4. [Run request]

A POST request to /api/data_source_sql creates a new SQL Data Source.

1. Item: data_source_sql
2. Method: POST
3. ID: Enter the ID of an existing SQL Data Source to use as a template. After entering it, the Request body is pre-filled with that Data Source's settings.
4. Select JSON Request and modify the request body:
   • To copy an existing Data Source, provide a unique name and a password, and keep the other settings.
   • To point at a different database, also update the relevant connection parameters (host_name, port, database_name, username, password).
5. Enter an API Token.
6. [Run request]

A PUT request to /api/data_source_sql/id/<id> with the body {"call": "test_connection"} validates the connection.

1. Item: data_source_sql
2. Method: PUT
3. ID: The ID of the SQL Data Source to test.
4. Actions: Test Connection.
5. Enter an API Token.
6. [Run request]

A DELETE request to /api/data_source_sql/id/<id> deletes a SQL Data Source.

1. Item: data_source_sql
2. Method: DELETE
3. ID: The ID of the SQL Data Source to delete.
4. Enter an API Token.
5. [Run request]

A GET request to /api/data_source_plugin returns the Plugin Data Sources.

1. Item: data_source_plugin
2. Method: GET
3. Enter an API Token.
4. [Run request]

A PUT request to /api/data_source_plugin/id/<id> runs an action against a Plugin Data Source. The action is selected with the call parameter (the Actions drop-down list in the API Toolkit).

1. Item: data_source_plugin
2. Method: PUT
3. ID: The ID of the Plugin Data Source.
4. Actions / call: Choose one of the actions:
   • refresh_list: Re-fetch the list of the plugin's External Reports.
   • refresh_security_cache: Refresh the external-tool security caches for this Plugin Data Source. Only works for plugins that support row-level security (such as Tableau and Power BI).
   • get_token: Return an access token for the Plugin Data Source. The access_token field will be empty if the plugin does not use OAuth or token-based authentication, or if valid credentials have not been configured for the profile.
   • update_user_role: Sync user roles and licenses with the source system. Only supported by the Tableau plugin.
5. Enter an API Token.
6. [Run request]

{
  "data_source_parameters": [
    { "id": 101, "profile": 21, "name": "site", "value": "Sales" },
    { "id": 102, "profile": 21, "name": "api_version", "value": "3.15" }
  ]
}

{
  "data_source_external_reports": [
    {
      "id": 8842,
      "name": "Quarterly Sales",
      "external_report": "wb-1234",
      "parent_external_report": "proj-55",
      "parent_id": 880,
      "metadata": {}
    }
  ]
}