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 Dataset resource and the Set Metadata operation, it enables writing or updating metadata information about a dataset within a specified project in Dataiku DSS.

Typical use cases include:

  • Automating the update of dataset metadata as part of a data pipeline.
  • Managing dataset descriptions, tags, or custom metadata fields programmatically.
  • Synchronizing metadata changes from external systems into Dataiku DSS.

For example, you might use this node to update the metadata of a dataset after processing or validation steps, ensuring that the dataset's metadata reflects its current state or lineage.

Properties

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

Output

The node outputs the response from the Dataiku DSS API after attempting to set the dataset metadata. The output is structured as JSON and typically contains confirmation or details of the updated metadata.

  • The json field contains the parsed JSON response from the API.
  • If the API returns no content, the node outputs a status code indicating "204 No Content".
  • This operation does not produce binary data output.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS server.
  • 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 credentials, ensure that the Dataiku DSS API credentials are properly configured in n8n.
  • Required Parameters Missing: Errors like "Project Key is required" or "Dataset Name is required" indicate that these mandatory parameters were not provided. Make sure to fill in all required fields.
  • Invalid JSON in Request Body: The request body must be valid JSON. Invalid JSON will cause the API call to fail.
  • API Errors: If the API returns errors, check the message for details. Common issues include insufficient permissions, invalid project or dataset names, or malformed metadata.
  • Network Issues: Ensure that the n8n instance can reach the Dataiku DSS server URL and that there are no firewall or network restrictions.

Links and References


This summary focuses on the Dataset resource with the Set Metadata operation, describing how to configure and use the node to update dataset metadata via the Dataiku DSS API.

Discussion