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 Recipe resource and the Set Recipe Metadata operation, it enables updating or writing metadata about a specific recipe within a given project.

Typical use cases include:

  • Automating updates to recipe metadata as part of a data pipeline.
  • Synchronizing recipe metadata changes from external systems.
  • Managing recipe configurations programmatically without manual intervention in the Dataiku DSS UI.

For example, you might use this node to update tags, descriptions, or custom metadata fields of a recipe after running a data transformation step.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the recipe.
Recipe Name The name of the recipe whose metadata is to be set or updated.
Request Body A JSON object representing the metadata content to write to the recipe.

Output

The node outputs the response from the Dataiku DSS API after attempting to set the recipe metadata. The output is a JSON object reflecting the result of the operation, which typically includes confirmation of the update or details of the new metadata state.

If the API returns binary data (not typical for this operation), it would be provided as binary output, but for setting recipe metadata, the output is JSON.

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

Troubleshooting

  • Missing Credentials Error: If the API key credential is not provided or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Errors: The node validates required parameters such as Project Key and Recipe Name. Omitting these will cause errors specifying which parameter is missing.
  • API Request Failures: Network issues, incorrect project or recipe names, or insufficient permissions can cause API call failures. The node surfaces these errors with messages from the Dataiku DSS API.
  • Invalid JSON in Request Body: The Request Body must be valid JSON. Malformed JSON will cause parsing errors before the request is sent.

To resolve issues:

  • Ensure all required parameters are correctly set.
  • Verify API credentials and permissions.
  • Validate the JSON structure in the Request Body.
  • Check network connectivity to the Dataiku DSS server.

Links and References


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

Discussion