Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API to perform various operations on Dataiku resources. Specifically, for the Dashboard resource and the Delete Dashboard operation, it allows users to delete a dashboard within a specified project in Dataiku DSS.

Common scenarios where this node is beneficial include:

  • Automating the cleanup of dashboards that are no longer needed.
  • Managing dashboards programmatically as part of a larger workflow or CI/CD pipeline.
  • Integrating dashboard management into data engineering or data science automation processes.

Example use case:

  • A user wants to automatically delete obsolete dashboards from a project after archiving their data or reports elsewhere.

Properties

Name Meaning
Project Key The key identifier of the Dataiku project containing the dashboard.
Dashboard ID The unique identifier of the dashboard to be deleted within the specified project.

Output

The output of the node is a JSON array containing the response from the Dataiku DSS API after attempting to delete the dashboard. Typically, for a delete operation, the response might be empty or contain status information confirming the deletion.

If the operation returns binary data (not typical for delete), it would be provided as binary output, but for deleting a dashboard, the output is JSON indicating success or failure.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Dataiku DSS API Credentials," ensure that the API key credential is properly set up in n8n.
  • Required Parameter Errors: The node validates required parameters such as Project Key and Dashboard ID. If these are missing, errors like "Project Key is required" or "Dashboard ID is required" will occur. Make sure to provide these inputs.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credentials.
  • Unexpected Response Format: If the API returns unexpected data, the node attempts to parse JSON; if parsing fails, raw text is returned. Check the API response for error messages.

Links and References


This summary focuses on the "Dashboard" resource and the "Delete Dashboard" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion