Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to interact programmatically with various Dataiku DSS resources. Specifically, for the Recipe resource and the Get Recipe Settings operation, it retrieves the settings of a specified recipe within a given project.

Typical use cases include:

  • Automating retrieval of recipe configurations for auditing or documentation.
  • Integrating recipe metadata into workflows for dynamic decision-making.
  • Monitoring or exporting recipe settings as part of larger data pipeline management.

Example: You want to fetch the configuration details of a recipe named "Data_Cleaning" in project "MyProject" to verify its parameters before triggering downstream processes.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the recipe.
Recipe Name The name of the recipe whose settings you want to retrieve.

These properties are required to specify which recipe's settings to get.

Output

The node outputs the response from the Dataiku DSS API call to get recipe settings. The output is structured as JSON and contains the detailed settings/configuration of the specified recipe.

  • The json field includes all recipe settings returned by the API.
  • 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) for authentication with the Dataiku DSS API.
  • The node expects the base URL of the DSS server and the user API key credential to be configured in n8n.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: Errors will occur if either the Project Key or Recipe Name is not provided, as these are mandatory to form the API request URL.
  • API Request Failures: Network issues, incorrect project or recipe names, or insufficient permissions can cause API errors. The node surfaces these errors with messages prefixed by "Error calling Dataiku DSS API".
  • Parsing Errors: If the API returns non-JSON responses unexpectedly, the node attempts to handle them gracefully but may output raw text or logs instead.

To resolve common issues:

  • Verify that the API credentials are correctly configured and have sufficient permissions.
  • Double-check the Project Key and Recipe Name inputs for correctness.
  • Ensure network connectivity to the Dataiku DSS server.
  • Review the error message details for specific API error codes or messages.

Links and References


This summary focuses on the Recipe resource's Get Recipe Settings operation as requested, based on static analysis of the provided source code and input property definitions.

Discussion