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 Project Folder resource and the Get Project Folder operation, the node retrieves the definition/details of a specified project folder by its folder ID.

Common scenarios where this node is beneficial include:

  • Automating retrieval of project folder metadata within Dataiku DSS projects.
  • Integrating project folder information into workflows for reporting or further processing.
  • Managing project organization programmatically by accessing folder details.

Practical example:

  • A user wants to fetch details about a specific project folder in Dataiku DSS to check its properties before moving or modifying it in an automated workflow.

Properties

Name Meaning
Folder ID The unique identifier of the project folder to retrieve. Required for the Get Project Folder operation.

(Note: The provided input properties JSON only includes "Folder ID" relevant to several operations including projectFoldersGet.)

Output

The node outputs the response from the Dataiku DSS API call as JSON data. For the Get Project Folder operation, the output JSON contains the detailed definition of the requested project folder, which typically includes metadata such as folder name, description, parent folder, creation date, and other folder-specific attributes as defined by the Dataiku DSS API.

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

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 expects the Dataiku DSS server URL and user API key to be configured in the credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing Dataiku DSS API credentials, ensure that the API key credential is properly set up in n8n.
  • Required Parameter Missing: Errors like "Folder ID is required" indicate that the necessary input property was not provided. Make sure to specify the Folder ID when using the Get Project Folder operation.
  • API Request Failures: Network issues, incorrect server URL, or invalid API keys can cause request failures. Verify connectivity and credentials.
  • Unexpected Response Format: If the node fails to parse the response, check if the Dataiku DSS API endpoint is returning valid JSON or expected data.

Links and References


This summary focuses on the Project Folder resource and the Get Project Folder operation as requested, based on static analysis of the provided source code and input properties.

Discussion