Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Bundles Design-Side resource and the Delete Exported Bundle operation, the node enables deletion of an exported bundle from a specified project in Dataiku DSS.

Common scenarios where this node is beneficial include:

  • Automating the management of project bundles by deleting outdated or unnecessary exported bundles.
  • Integrating bundle lifecycle management into larger workflows that handle project deployment or cleanup.
  • Maintaining project storage hygiene by programmatically removing exported bundles no longer needed.

Practical example:

  • A user wants to delete an exported bundle identified by its Bundle ID from a specific project identified by its Project Key. This node can be configured to perform that deletion via the Dataiku DSS API within an automated workflow.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project containing the exported bundle.

Note: For the "Delete Exported Bundle" operation under the "Bundles Design-Side" resource, the required input properties are:

  • Project Key: Identifies the project from which the exported bundle will be deleted.
  • Bundle ID (not listed in the provided properties but required as per code): The identifier of the exported bundle to delete.

The node expects these parameters to construct the appropriate API endpoint for the deletion request.

Output

The output of this node after executing the "Delete Exported Bundle" operation is a JSON object representing the response from the Dataiku DSS API. Since this is a DELETE operation, the typical successful response might be empty or contain status information confirming the deletion.

The output structure is:

  • json: Contains the parsed JSON response from the API if any.
  • If the API returns no content (HTTP 204), the node outputs a JSON object with "Status Code": "204 No Content".

No binary data output is expected for this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key credential) for authentication with the Dataiku DSS API.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.
  • The base URL for the API is constructed using the DSS server address from the credentials.
  • The node requires the n8n environment to have network access to the Dataiku DSS server.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing Dataiku DSS API credentials, ensure that the API key credential is properly configured in n8n.
  • Missing Required Parameters: Errors like "Project Key is required" or "Bundle ID is required" indicate that necessary input parameters were not provided. Verify that all required fields are set.
  • API Endpoint Errors: If the API returns errors, check that the project key and bundle ID correspond to existing resources in Dataiku DSS and that the API user has sufficient permissions.
  • Network Issues: Connection failures may occur if the DSS server is unreachable; verify network connectivity and server availability.
  • Unexpected Response Format: If the response cannot be parsed as JSON, it may indicate an API issue or unexpected server response.

Links and References

Discussion