Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

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. It supports many resource types such as projects, datasets, dashboards, machine learning models, flow documentation, and more.

Specifically for the Flow Documentation resource with the operation Generate Flow Documentation From Default Template, the node triggers the generation of flow documentation using Dataiku DSS's default template for a specified project.

Common scenarios where this node is beneficial include:

  • Automating the generation of project flow documentation as part of CI/CD pipelines.
  • Integrating documentation generation into broader data workflows.
  • Scheduling regular updates of flow documentation without manual intervention.

Example use case:

  • A user wants to generate updated flow documentation for a Dataiku project every night automatically. They configure this node with the project key and select the "Generate Flow Documentation From Default Template" operation to trigger the documentation generation via the API.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project for which the flow documentation will be generated.

Output

The node outputs the response from the Dataiku DSS API call in JSON format under the json field. For the "Generate Flow Documentation From Default Template" operation, the output typically contains metadata or status information about the triggered documentation generation process.

No binary data output is expected for this operation.

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 node throws an error about missing API credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Project Key Required: The operation requires a valid project key. If omitted or incorrect, the node will throw an error indicating the missing project key.
  • API Errors: Any errors returned by the Dataiku DSS API (e.g., permission denied, invalid project key) will be surfaced as node errors. Check the API response message for details.
  • Network Issues: Ensure that the n8n instance can reach the Dataiku DSS server URL and that no firewall or network restrictions block the request.

Links and References

Discussion