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 various Dataiku DSS resources. Specifically for the Macro resource and the Get Run Macro State operation, it allows users to retrieve the current status of a specific run of a macro within a project.

Typical use cases include:

  • Monitoring the execution state of macros triggered in Dataiku DSS workflows.
  • Automating workflows that depend on the completion or status of macro runs.
  • Integrating macro run status checks into larger automation pipelines.

For example, you might use this node to check if a macro run has completed successfully before proceeding with downstream data processing steps.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project where the macro is executed.
Runnable Type The type/category of the runnable entity (e.g., macro) to identify the macro's context.
Run The identifier of the specific macro run whose state you want to retrieve.

Output

The node outputs JSON data representing the state of the specified macro run. This typically includes details such as the current status, progress, any error messages, and other metadata related to the macro execution state.

If the macro run state is successfully retrieved, the output will be a JSON object containing this information.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key credential) 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 credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Required Parameters Missing: Errors like "Project Key is required", "Runnable Type is required", or "Run is required" indicate that these input properties must be provided for the operation to succeed.
  • API Request Failures: Network issues, incorrect project keys, or invalid run IDs can cause API call failures. Verify all inputs and network connectivity.
  • Unexpected Response Format: If the response cannot be parsed as JSON, check if the API endpoint is returning an error or unexpected content.

Links and References

Discussion