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 directly from n8n workflows. Specifically for the Dataset Statistic resource and the Create Worksheet operation, it allows creating a new statistics worksheet within a specified dataset in a project.

Use cases include automating the creation of statistical worksheets for datasets to facilitate data analysis, reporting, or further processing within Dataiku DSS projects. For example, you might use this node to programmatically generate worksheets that summarize dataset statistics as part of a larger data pipeline or monitoring workflow.

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 project where the worksheet will be created.
Request Body A JSON object representing the details of the worksheet to create (e.g., configuration).
  • Project Key: Specifies which project the dataset belongs to.
  • Dataset Name: Identifies the target dataset for the new worksheet.
  • Request Body: Contains the JSON payload with the worksheet's properties and settings to be created.

Output

The node outputs the response from the Dataiku DSS API after creating the worksheet. The output is a JSON object representing the newly created worksheet, including its metadata and identifiers.

If the operation involves binary data (not typical for this operation), the node would provide the binary content accordingly, but for "Create Worksheet," the output is JSON only.

Example output structure (simplified):

{
  "id": "worksheet_id",
  "name": "Worksheet Name",
  "description": "Description of the worksheet",
  "createdAt": "timestamp",
  "updatedAt": "timestamp",
  ...
}

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs valid API credentials (an API key) configured in n8n to authenticate requests.
  • The node uses HTTP requests to interact with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials. Ensure you have configured the required API key credential properly.
  • Required Parameter Errors: The node validates essential parameters like Project Key, Dataset Name, and Worksheet ID (if applicable). Missing these will cause errors. Double-check that all required fields are filled.
  • API Endpoint Errors: If the Dataiku DSS server URL is incorrect or unreachable, the node will fail to connect. Verify network connectivity and server address.
  • Invalid JSON in Request Body: The request body must be valid JSON. Malformed JSON will cause the API call to fail.
  • Permission Issues: The API key used must have sufficient permissions to create worksheets in the specified project and dataset.

Links and References

This summary focuses on the Dataset Statistic resource and the Create Worksheet operation as requested, based on static analysis of the provided source code and property definitions.

Discussion