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 Macro resource and the Get Macro operation, it retrieves the definition of a macro within a specified project.

Common scenarios where this node is beneficial include:

  • Automating retrieval of macro definitions for auditing or documentation.
  • Integrating macro metadata into workflows for dynamic processing.
  • Managing macros programmatically as part of larger data pipeline automation.

Practical example:

  • You want to fetch the details of a specific macro in a Dataiku project to inspect its configuration or code before triggering it or modifying it.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku project containing the macro.
Runnable Type The type of runnable entity (e.g., macro) to target. Required for macro-related actions.

Note: For the "Get Macro" operation, the node requires the Project Key and Runnable Type properties to construct the API request.

Output

The node outputs the response from the Dataiku DSS API call in the json field of the output item. For the "Get Macro" operation, this will be the JSON representation of the macro's definition as returned by the API.

If the API returns binary data (not typical for "Get Macro"), the node prepares it as binary data under the binary.data field with an appropriate filename.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Dataiku DSS API Credentials", ensure that you have configured the required API key credential in n8n.
  • Required Parameter Errors: The node validates required parameters like Project Key and Runnable Type. Missing these will cause errors such as "Project Key is required" or "Runnable Type is required".
  • API Request Failures: Network issues, incorrect server URL, or invalid API keys can cause request failures. Check the credentials and network connectivity.
  • Parsing Errors: If the API response is not valid JSON, the node attempts to return raw text. Unexpected formats may require checking the API endpoint or parameters.

Links and References

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

Discussion