Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Scenario → List Scenarios

AI-generated

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 List Scenarios operation, it retrieves a list of scenarios within a specified project.

Common use cases include:

  • Automating retrieval of scenario lists for monitoring or reporting.
  • Integrating scenario data into workflows for further processing or decision-making.
  • Managing scenarios programmatically as part of CI/CD pipelines or operational automation.

Example: You want to fetch all scenarios in a project to check their status or trigger runs conditionally based on scenario properties.

Properties

Name Meaning
Project Key The unique identifier of the project from which to list scenarios.

The provided input property is:

[
  {
    "displayName": "Project Key",
    "name": "projectKey",
    "type": "string",
    "default": "",
    "displayOptions": {
      "show": {
        "operation": ["scenariosList"]
      }
    }
  }
]

This means the user must provide the project key to list scenarios belonging to that project.

Output

The output JSON contains an array of scenario objects, each representing a scenario with its details and status. The exact structure corresponds to the Dataiku DSS API response for listing scenarios, typically including fields such as scenario ID, name, description, status, last run info, and other metadata.

No binary data output is associated with this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication against 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 API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Missing Project Key: The node requires the project key to be specified; otherwise, it throws an error stating that the project key is required.
  • API Request Failures: Network issues, incorrect server URL, or insufficient permissions can cause API call failures. Check the DSS server accessibility and API key permissions.
  • Unexpected Response Format: If the API returns unexpected data or errors, ensure the DSS version supports the requested operation and the API endpoint is correct.

Links and References

This summary focuses on the Scenario resource's List Scenarios operation as requested, based on static analysis of the provided source code and input properties.

Discussion