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 Scenario resource and the Abort Scenario operation, it enables aborting a running scenario within a specified project. This is useful in automation workflows where you need to programmatically stop a scenario execution that may be stuck, running longer than expected, or needs to be halted due to some condition.

Common scenarios include:

  • Automatically stopping a scenario if certain conditions are met (e.g., data quality checks fail).
  • Managing scenario executions dynamically from an external workflow.
  • Integrating scenario control into broader data pipelines or orchestration systems.

Example use case:

  • A user triggers this node to abort a scenario identified by its ID in a specific project when an upstream validation step fails, preventing further downstream processing.

Properties

Name Meaning
Project Key The key identifier of the Dataiku project containing the scenario.
Scenario ID The unique identifier of the scenario to abort.

These properties are required to specify which scenario in which project should be aborted.

Output

The output of the node is a JSON array containing the response from the Dataiku DSS API after attempting to abort the scenario. The structure typically includes confirmation or status information about the abort request.

If the API returns textual logs or binary data (not typical for abort operation), the node handles those accordingly, but for aborting a scenario, the output will be JSON indicating success or failure.

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 base URL of the DSS server and the API key credential to be configured in n8n.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Dataiku DSS API Credentials", ensure that the API key credential is properly set up in n8n.
  • Required Parameter Missing: Errors like "Project Key is required" or "Scenario Key is required" indicate that these inputs were not provided; verify that these fields are correctly filled.
  • API Request Failures: Network issues, incorrect project or scenario IDs, or insufficient permissions can cause API errors. Check the API endpoint URL and credentials.
  • Unexpected Response Format: If the API returns unexpected data, check the Dataiku DSS API version compatibility and node configuration.

Links and References


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

Discussion