Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node interacts with the Dataiku DSS API to perform various operations on different resources within a Dataiku DSS instance. Specifically, for the Scenario resource and the Get Scenario Status operation, it retrieves basic information and the current status of a specified scenario within a project.

Typical use cases include monitoring the execution state of scenarios in Dataiku DSS workflows, enabling automation flows to react based on scenario statuses, or integrating scenario status checks into larger data pipelines.

For example, you might use this node to:

  • Check if a scenario is currently running or idle before triggering dependent processes.
  • Monitor scenario health and alert if a scenario fails or is stopped unexpectedly.
  • Integrate scenario status retrieval into dashboards or reporting tools.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project containing the scenario.
Scenario ID The identifier of the scenario whose status you want to retrieve.

Output

The node outputs JSON data representing the scenario's basic information and its current status. This typically includes fields such as scenario metadata, last run status, and other relevant status indicators provided by the Dataiku DSS API.

If the operation involves downloading files (not applicable here), binary data would be output accordingly, but for "Get Scenario Status," the output is purely JSON.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs an API authentication token credential configured in n8n to authorize requests to the Dataiku DSS API.
  • The node constructs HTTP requests to the Dataiku DSS REST API endpoints based on the selected resource and operation.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials. Ensure that the API key credential is properly configured.
  • Required Parameter Missing: Errors like "Project Key is required" or "Scenario Key is required" indicate that mandatory input parameters were not provided. Verify that all required properties are filled.
  • API Request Failures: Network issues, incorrect server URLs, or insufficient permissions can cause request failures. Check connectivity, API endpoint correctness, and user permissions in Dataiku DSS.
  • Unexpected Response Format: If the API returns unexpected data or errors, the node may fail to parse the response. Review the API response and ensure compatibility with the node version.

Links and References

Discussion