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 Notebook resource and the List Jupyter Notebook Names operation, the node retrieves the list of Jupyter notebook names within a specified project.

This functionality is useful when you want to programmatically access or manage Jupyter notebooks in a Dataiku DSS project, such as listing available notebooks before performing further actions like opening, updating, or deleting them.

Practical example:

  • You have a Dataiku DSS project and want to automate the retrieval of all Jupyter notebook names to display them in a dashboard or use them as input for another workflow step.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project from which to list Jupyter notebooks.
Query Parameters Optional additional query parameters to filter or modify the API request (key-value pairs).

Output

The output is a JSON array where each item represents a Jupyter notebook name retrieved from the specified project. The exact structure depends on the Dataiku DSS API response but typically includes notebook identifiers and metadata.

If the operation involves downloading files (not applicable for listing notebook names), the node can output binary data representing the downloaded file.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires an API key credential for authenticating 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 API key credential is not provided or invalid, the node will throw an error indicating missing credentials.
  • Project Key Required: The node requires the "Project Key" property to be set; otherwise, it throws an error.
  • API Errors: Any errors returned by the Dataiku DSS API (e.g., unauthorized access, resource not found) will be surfaced as node errors with descriptive messages.
  • Network Issues: Ensure that the Dataiku DSS server URL is reachable from the n8n environment.

Links and References


Note: This summary focuses on the "Notebook" resource and the "List Jupyter Notebook Names" operation as requested. The node supports many other resources and operations beyond this scope.

Discussion