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 Dataiku DSS resources. Specifically for the Project resource and the List Projects operation, it retrieves a list of projects from a Dataiku DSS instance.

Common scenarios where this node is beneficial include:

  • Automating project management workflows by listing all projects available in a Dataiku DSS instance.
  • Integrating project metadata retrieval into larger automation pipelines.
  • Filtering or processing projects programmatically based on criteria provided via query parameters.

For example, a user might use this node to fetch all projects and then trigger further actions such as exporting project data, updating permissions, or running analyses on selected projects.

Properties

Name Meaning
Query Parameters A collection of optional parameters to filter or modify the list request. Options include: Active (boolean), Activity (string), All Users (boolean), Archive Path (string), Catalog Name (string), Code Env Name (string), Column Name (string), Columns (string), Connected (boolean), Connection Name (string), Container Execution Configuration Name (string), Deletion Mode (string), Destination ID (string), Drop Data (boolean), Export Analysis Models (boolean), Export Managed (boolean), Export Saved Models (boolean), Export Uploads (boolean), File Part (string), Filter (string), Folder ID (string), Folder Reference (string), Force Rebuild Env (boolean), Foreign (boolean), Format (string), Format Params (string), Full Class Name (string), Full Reguess (boolean), Include All Partitions (boolean), Include Libs (boolean), Limit (number, min 1, default 50), Max Dataset Count (number), Metric Lookup (string), Min Timestamp (number), Name (string), Only Monitored (boolean), Page (number, default 1), Partition (string), Partitions (string), Path (string), Peek (boolean), Prediction Type (string), Project Folder ID (string), Project Key (string), Published Project Key (string), Published Service ID (string), Purpose (string), Remote (string), Remove Intermediate (boolean), Reassign To (string), Results per Page (number), Rule ID (string), Schema Name (string), Step ID (string), Sub-Folder Name (string), Tags (string), Target Variable (string), Time Series Identifiers (string), Time Variable (string), Trigger ID (string), Trigger Run ID (string), Trust For Everybody (boolean), Type (string), Versions (string), Wait (boolean), With Scenarios (boolean). These parameters allow fine control over the query to list projects.

| Project Key | The key of the project to scope the operation. Required for many project-related API calls including listing projects within a specific context.|

Output

The output is an array of JSON objects representing the response from the Dataiku DSS API for the list projects request. Each item corresponds to a project object returned by the API, containing project details such as project key, name, description, and other metadata as provided by the Dataiku DSS API.

If the operation involves downloading files or binary content (not applicable for List Projects but relevant for other operations), the node outputs binary data under the binary property with the file content.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires 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 node throws "Missing Dataiku DSS API Credentials", ensure that you have configured the API key credential correctly in n8n.
  • Required Parameter Missing: Many operations require mandatory parameters like Project Key. The node will throw errors if these are missing. Verify that all required fields are filled.
  • API Endpoint Errors: If the API returns errors, check the URL constructed by the node (logged in console) and verify the parameters and endpoint correctness.
  • Parsing Errors: If the response cannot be parsed as JSON, the node attempts to return raw text or binary data. Ensure the API response matches expected formats.
  • Network Issues: Connectivity problems to the Dataiku DSS server will cause request failures. Check network access and server availability.

Links and References

This summary focuses on the Project resource and the List Projects operation, describing how the node constructs the API request, handles authentication, and processes the response accordingly.

Discussion