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 DSS resources. Specifically, for the Notebook resource and the Create Jupyter Notebook operation, it allows users to create a new Jupyter notebook within a specified Dataiku project.

Typical use cases include automating the creation of notebooks as part of data science workflows, enabling programmatic management of notebooks in Dataiku projects, or integrating notebook creation into larger automation pipelines.

For example, a user might automate the creation of a notebook named "Analysis_2024" in a project to prepare an environment for exploratory data analysis or model development.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project where the notebook will be created.
Notebook Name The name of the Jupyter notebook to create within the specified project.
Request Body (Optional) A JSON object representing additional request parameters or body content.

Output

The node outputs the response from the Dataiku DSS API after attempting to create the notebook. The output is structured as JSON containing details about the newly created notebook or any relevant metadata returned by the API.

If the operation involves binary data (not typical for notebook creation), the node would output binary data accordingly, but for creating a notebook, the output is JSON.

Example output JSON structure:

{
  "id": "notebook_id",
  "name": "notebook_name",
  "projectKey": "project_key",
  "createdAt": "timestamp",
  "updatedAt": "timestamp",
  "otherDetails": { ... }
}

Dependencies

  • Requires valid Dataiku DSS API credentials including:
    • The URL or hostname of the Dataiku DSS server.
    • An API key or token for authentication.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API.
  • No additional external libraries beyond those bundled with n8n are required.
  • The user must configure the Dataiku DSS API credentials securely in n8n before using this node.

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.
  • Project Key Required: The operation requires a valid project key; if omitted or incorrect, the node will throw an error.
  • Notebook Name Required: The notebook name must be provided; otherwise, the node will not proceed.
  • API Errors: Any errors returned by the Dataiku DSS API (e.g., permission denied, invalid project key) will be surfaced as node errors. Check the API response message for details.
  • Network Issues: Ensure that the n8n instance can reach the Dataiku DSS server URL and that no firewall or network restrictions block the connection.
  • Invalid JSON in Request Body: If providing a custom request body, ensure it is valid JSON to avoid parsing errors.

Links and References

This summary focuses on the "Notebook" resource and the "Create Jupyter Notebook" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion