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 Data Quality resource and the Get Data Quality Rules Configuration operation, it retrieves the configuration of data quality rules defined on a specified dataset within a project.

This is useful in scenarios where you want to automate monitoring or auditing of data quality rules applied to datasets in Dataiku DSS projects. For example, you might use this node to fetch the current set of data quality rules for a dataset before running automated checks or reporting on rule configurations.

Properties

Name Meaning
Project Key The unique identifier (key) of the Dataiku DSS project containing the dataset.
Dataset Name The name of the dataset within the project for which to retrieve data quality rules.

These properties are required to specify the exact dataset whose data quality rules configuration you want to get.

Output

The node outputs JSON data representing the data quality rules configuration for the specified dataset. This includes details about all the rules configured on that dataset, such as rule definitions, parameters, and settings.

  • The output is an array of JSON objects, each corresponding to the response from the Dataiku DSS API.
  • If the API returns binary data (not typical for this operation), it would be provided as binary output, but for this operation, the output is JSON only.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (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 API credentials are not set or invalid, the node will throw an error indicating missing Dataiku DSS API credentials.
  • Required Parameter Missing: The node validates required parameters like Project Key and Dataset Name. If these are missing, it throws errors specifying which parameter is required.
  • API Request Errors: Any HTTP or API errors returned by the Dataiku DSS server will be surfaced as node errors with messages prefixed by "Error calling Dataiku DSS API".
  • Parsing Errors: If the API response is not valid JSON when expected, the node attempts to handle it gracefully but may throw parsing errors.

To resolve issues:

  • Ensure the API credentials are correctly configured.
  • Verify that the Project Key and Dataset Name are correctly provided.
  • Check network connectivity and Dataiku DSS server availability.
  • Review API permissions for the user associated with the API key.

Links and References


This summary focuses on the Data Quality resource and the Get Data Quality Rules Configuration operation as requested.

Discussion