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 Dataiku DSS resources. Specifically for the Dataset resource and the Get Metadata operation, the node retrieves metadata information about a specified dataset within a project in Dataiku DSS.

Common scenarios where this node is beneficial include:

  • Automating data pipeline workflows by programmatically fetching dataset metadata.
  • Integrating Dataiku DSS datasets metadata into other systems or dashboards.
  • Validating dataset properties before further processing or analysis.

Practical example:

  • A user wants to fetch metadata details (such as schema, creation date, owner, etc.) of a dataset named "sales_data" in the project "RetailProject" to verify its structure before running an automated data quality check.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the dataset.
Dataset Name The name of the dataset within the specified project whose metadata is to be retrieved.

Output

The output JSON contains the metadata information of the requested dataset as returned by the Dataiku DSS API. This typically includes details such as dataset schema, creation and modification timestamps, owner information, tags, and other descriptive metadata fields.

If the operation involves downloading files (not applicable for Get Metadata), the node can output binary data representing the downloaded file.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires 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.

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 Parameter Errors: The node validates required parameters like Project Key and Dataset Name. Missing these will cause errors. Make sure these inputs are provided.
  • API Request Failures: Network issues or incorrect server URLs can cause request failures. Verify connectivity and correct server address.
  • Unexpected Response Format: If the response cannot be parsed as JSON, it might indicate an API issue or unexpected response. Check the API server logs or response content.

Links and References


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

Discussion