Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on Dataiku DSS resources programmatically. It is designed to interact with various Dataiku DSS entities such as projects, bundles, datasets, models, scenarios, and more.

For the Project resource with the Create Project operation, the node enables creating new projects within Dataiku DSS by sending appropriate API requests. This is useful for automating project setup workflows, integrating project creation into larger automation pipelines, or managing multiple projects dynamically.

Practical examples:

  • Automatically create a new Dataiku DSS project when a new client onboarding process starts.
  • Integrate project creation into CI/CD pipelines to prepare environments for data science teams.
  • Bulk-create projects based on external triggers or schedules.

Properties

Name Meaning
Query Parameters A collection of optional query parameters that can be added to the API request URL. These include many possible parameters like active, name, limit, tags, folderId, etc., which customize the API call behavior.
Request Body JSON object representing the body of the HTTP request. For creating a project, this would contain the project details and configuration in JSON format.
projectKey The unique key identifier for the project. Required for most project-related operations.

Note: The full list of query parameters includes many options (e.g., active, allUsers, archivePath, catalogName, deletionMode, exportAnalysisModels, filter, folderId, limit, name, page, tags, wait, and many others) that control various aspects of the API calls across different resources and operations.

Output

The node outputs an array of items where each item contains:

  • json: The parsed JSON response from the Dataiku DSS API corresponding to the requested operation. This typically includes the created project's metadata and status information when creating a project.
  • binary (optional): For some operations involving downloads (not applicable to project creation), binary data such as files or archives may be returned.

For the Create Project operation specifically, the output will be the JSON representation of the newly created project as returned by the Dataiku DSS API.

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 uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.
  • No additional external libraries beyond those bundled with n8n are required.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node throws an error indicating missing Dataiku DSS API credentials. Ensure you have configured the API key credential correctly.
  • Required Parameter Missing: The node validates required parameters such as projectKey for project operations. If these are missing, it throws descriptive errors. Make sure all mandatory fields are filled.
  • API Request Failures: Errors from the Dataiku DSS API (e.g., network issues, permission denied, invalid payload) are caught and reported with messages prefixed by "Error calling Dataiku DSS API". Check your API endpoint URL, credentials, and request body.
  • Invalid JSON in Request Body: The requestBody property must be valid JSON. Invalid JSON will cause parsing errors.
  • Binary Data Handling: For operations returning files, ensure the node is configured to handle binary data properly.

Links and References

This summary focuses on the Project resource and the Create Project operation, describing how the node constructs the API request, handles inputs, and processes outputs accordingly.

Discussion