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 Update Scenario Payload operation, it enables updating the payload (configuration or data) of an existing scenario within a specified project.

Common scenarios where this node is beneficial include automating scenario management in Dataiku DSS projects, such as programmatically modifying scenario inputs or parameters before triggering runs or integrating scenario updates into larger workflows.

For example, you might use this node to update the input payload of a scenario to change its behavior dynamically based on upstream data or external triggers, enabling flexible automation of data pipelines managed by Dataiku DSS.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project containing the scenario.
Scenario ID The identifier of the scenario whose payload you want to update.
Request Body A JSON object representing the new payload content to set for the scenario.

Output

The output of this operation is the JSON response from the Dataiku DSS API after updating the scenario payload. It typically contains confirmation details or the updated scenario payload information.

  • The output is returned as a JSON array with one element per input item.
  • If the API returns binary data (not typical for this operation), it would be provided as binary data, but for updating scenario payloads, the response is JSON.
  • In case of no content returned by the API, the node outputs a status code message indicating "204 No Content".

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.
  • No additional external dependencies beyond the Dataiku DSS API and n8n's HTTP request capabilities.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly configured 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 specifying which parameter is required.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credentials.
  • Invalid JSON in Request Body: Ensure the Request Body property contains valid JSON; otherwise, parsing errors may occur.
  • Unexpected Response Format: If the API response cannot be parsed as JSON, the raw text is returned. Check the API documentation or logs for unexpected responses.

Links and References


This summary focuses on the Scenario resource's Update Scenario Payload operation, describing how to configure and use the node to update scenario payloads in Dataiku DSS via its API.

Discussion