Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the "Plugin" resource and the "Add Folder to Plugin" operation, it allows adding a new folder to an existing plugin in a Dataiku DSS instance.

Common scenarios where this node is beneficial include automating plugin management tasks such as updating plugin contents, managing plugin files and folders, and integrating plugin lifecycle actions into workflows. For example, a user can automate the addition of new folders to plugins as part of a CI/CD pipeline or during plugin development and deployment processes.

Practical example: You have a plugin in your Dataiku DSS project and want to programmatically add a new folder to organize additional scripts or resources. This node operation lets you specify the plugin ID and the path of the new folder to be added, streamlining plugin content management without manual intervention.

Properties

Name Meaning
Plugin ID The unique identifier of the plugin to which the folder will be added.
Path The relative path specifying the folder name or location to add inside the plugin.

Output

The node outputs JSON data representing the response from the Dataiku DSS API after attempting to add the folder to the specified plugin. The output typically includes details about the success or failure of the operation, and any relevant metadata returned by the API.

If the operation involves downloading files (not applicable here), the node can output binary data representing the downloaded content. For this operation, the output is JSON only.

Dependencies

  • Requires valid Dataiku DSS API credentials, including:
    • The URL or address of the Dataiku DSS server.
    • A user API key for authentication.
  • The node must be configured with these credentials in n8n before execution.
  • The Dataiku DSS instance must have the plugin identified by the provided Plugin ID.

Troubleshooting

  • Missing Credentials: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Required Parameters Missing: Errors like "Plugin ID is required" or "Path is required" indicate that mandatory input properties were not provided. Verify that these fields are filled.
  • API Errors: If the API returns errors, check the plugin ID validity, permissions, and whether the path already exists or conflicts with existing folders.
  • Network Issues: Connection problems to the Dataiku DSS server can cause failures; verify network connectivity and server availability.
  • Unexpected Response Format: If the node cannot parse the API response, ensure the Dataiku DSS API version is compatible and the server returns expected JSON responses.

Links and References


This summary focuses on the "Plugin" resource and the "Add Folder to Plugin" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion