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 Workspace resource and the Create Workspace Object operation, it allows users to add a new object (such as a DSS object, an application, or an HTML link) to a specified workspace in Dataiku DSS.

Common scenarios where this node is beneficial include:

  • Automating the management of workspace contents by programmatically adding relevant objects.
  • Integrating workspace updates into larger workflows that manage projects and their components.
  • Dynamically linking applications or documents within a workspace based on external triggers or data changes.

For example, you might use this node to automatically add a newly created dataset or dashboard link to a workspace after its creation, improving accessibility for team members.

Properties

Name Meaning
Workspace Key The unique identifier of the workspace where the object will be added.
Request Body A JSON object representing the details of the workspace object to create (e.g., type, name, URL).

The Request Body property expects a JSON structure defining the workspace object attributes according to the Dataiku DSS API specification for workspace objects.

Output

The node outputs the response from the Dataiku DSS API after attempting to create the workspace object. The output is provided in the json field and typically contains the details of the created workspace object as returned by the API.

If the operation involves binary data (not typical for this operation), the node would provide it in a binary field, but for creating workspace objects, the output is JSON only.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Dataiku DSS API credentials are properly configured in n8n.
  • Required Parameter Errors: The node validates required parameters such as Workspace Key. If these are missing, the node will throw descriptive errors. Make sure all required fields are filled.
  • API Request Failures: Network issues, incorrect server URLs, or insufficient permissions can cause API request failures. Verify the server address, network connectivity, and user permissions.
  • Invalid JSON in Request Body: Ensure the JSON provided in the "Request Body" property is well-formed and matches the expected schema for workspace objects.

Links and References


This summary focuses on the Workspace resource and the Create Workspace Object operation as requested, based on static analysis of the provided source code and input properties.

Discussion