Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API to perform various operations on Dataiku resources. Specifically, for the Notebook resource and the Update Jupyter Notebook operation, it allows users to update an existing Jupyter notebook within a specified project in Dataiku DSS.

Typical use cases include:

  • Automating updates to Jupyter notebooks stored in Dataiku projects.
  • Integrating notebook updates into larger workflows or pipelines.
  • Managing notebook content programmatically without manual intervention.

For example, you might use this node to push changes to a notebook after generating or modifying its content dynamically in a workflow.

Properties

Name Meaning
Project Key The key of the Dataiku project containing the notebook to update.
Notebook Name The name of the Jupyter notebook to update within the specified project.
Request Body A JSON object representing the content or metadata to update in the notebook.

Output

The output is a JSON array where each item corresponds to the response from the Dataiku DSS API for the update request. The structure depends on the API response but typically includes details about the updated notebook or confirmation of the update.

No binary data output is expected for this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires an API authentication token credential for Dataiku DSS (referred generically as "an API key credential").
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: The node validates required parameters such as Project Key and Notebook Name. Omitting these will cause errors specifying which parameter is missing.
  • API Errors: Any errors returned by the Dataiku DSS API (e.g., 404 if the notebook does not exist, 403 for permission issues) will be surfaced as node errors with descriptive messages.
  • Invalid JSON in Request Body: The Request Body must be valid JSON; otherwise, parsing errors may occur.
  • Network Issues: Connectivity problems to the Dataiku DSS server will result in request failures.

To resolve common errors:

  • Ensure all required fields are filled correctly.
  • Verify that the API key credential has sufficient permissions.
  • Confirm the Dataiku DSS server URL is reachable.
  • Validate the JSON format of the Request Body.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions.

Discussion