Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on Dataiku DSS resources. Specifically for the Recipe resource and the Update Recipe Settings operation, it allows updating the settings of an existing recipe within a specified project.

Common scenarios where this node is beneficial include automating the management of recipes in Dataiku DSS projects, such as modifying recipe configurations programmatically as part of CI/CD pipelines or data workflows. For example, you might update a recipe's parameters or metadata before triggering its execution, ensuring that the recipe runs with the desired configuration without manual intervention.

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 are to be updated.
Request Body A JSON object representing the new settings to apply to the recipe.
  • Project Key: Specifies which project the recipe belongs to.
  • Recipe Name: Identifies the specific recipe within the project.
  • Request Body: Contains the settings to update; this should be a valid JSON structure matching the expected schema for recipe settings in Dataiku DSS.

Output

The node outputs the response from the Dataiku DSS API after attempting to update the recipe settings. The output is structured as JSON and typically contains the updated recipe settings or confirmation of the update.

If the operation involves downloading files or binary content (not applicable specifically for updating recipe settings), the node would output binary data accordingly. However, for the Update Recipe Settings operation, the output is JSON.

Example output JSON structure:

{
  "recipeName": "example_recipe",
  "settings": {
    // Updated settings fields here
  },
  "status": "success"
}

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs an API key credential for authenticating requests to the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • No additional external dependencies beyond the Dataiku DSS API and n8n's HTTP request capabilities.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Required Parameters Missing: Errors indicating missing "Project Key" or "Recipe Name" mean these inputs were not provided. Verify that these properties are correctly filled.
  • Invalid JSON in Request Body: If the request body JSON is malformed, the API call will fail. Validate the JSON syntax before running the node.
  • API Endpoint Errors: If the API returns errors related to permissions or invalid project/recipe names, verify that the project and recipe exist and that the API key has sufficient permissions.
  • Network Issues: Connection timeouts or unreachable server errors indicate network problems or incorrect server URLs.

Links and References

This summary focuses on the Recipe resource's Update Recipe Settings operation, describing how to use the node to update recipe configurations via the Dataiku DSS API.

Discussion