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 Run Scenario operation, it enables starting the execution of a scenario within a specified project in Dataiku DSS.

Common scenarios where this node is beneficial include automating workflows by triggering scenarios programmatically, integrating scenario runs into larger automation pipelines, or running scenarios conditionally based on external events.

For example, you can use this node to:

  • Trigger a data processing scenario after new data arrives.
  • Automate scenario runs as part of a scheduled workflow.
  • Integrate scenario execution into CI/CD pipelines for data projects.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project containing the scenario to run.
Scenario ID The identifier of the scenario to be executed within the specified project.

Output

The output of the node is a JSON object representing the response from the Dataiku DSS API after attempting to run the scenario. This typically includes details about the scenario run initiation, such as run identifiers, status, or any error messages returned by the API.

If the API returns binary data (not typical for running scenarios), the node would prepare it accordingly, but for the "Run Scenario" operation, the output is JSON.

Example output structure (simplified):

{
  "runId": "string",
  "status": "string",
  "message": "string"
}

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs an API authentication token credential for Dataiku DSS with sufficient permissions to run scenarios.
  • 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 credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Required Parameter Errors: The node validates required parameters like Project Key and Scenario ID. If these are missing, the node will throw errors indicating which parameter is required.
  • API Request Failures: Network issues, incorrect server URLs, or insufficient permissions may cause API request failures. Check the Dataiku DSS server accessibility and API key permissions.
  • Unexpected Response Format: If the API returns unexpected data, verify the scenario exists and the API endpoint is correct.

Links and References

This summary focuses on the Scenario resource's Run Scenario operation extracted from the provided source code and property definitions.

Discussion