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 various Dataiku DSS resources. Specifically, for the Connection resource and the List Connections Names operation, the node fetches and lists all connection names available on the Dataiku DSS instance.

This functionality is useful when you want to retrieve an overview or inventory of all connections configured in your Dataiku DSS environment, for example, to dynamically select a connection for further processing or auditing purposes.

Practical Example

  • You want to list all connection names to display them in a dropdown for user selection in a workflow.
  • You need to audit or verify existing connections before creating new ones or updating existing configurations.

Properties

Name Meaning
Query Parameters A collection of optional key-value parameters to filter or modify the API 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), 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).

Note: The "Query Parameters" property allows flexible filtering or pagination options depending on the API endpoint's capabilities.

Output

The output is a JSON array where each item corresponds to a connection name retrieved from the Dataiku DSS instance.

  • The json field contains the parsed response from the API listing connection names.
  • If the operation involves downloading files or binary data (not applicable here), the node would provide binary data accordingly.

For the List Connections Names operation, the output will be a JSON object or array containing the names of connections, suitable for use in subsequent workflow steps.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key credential) for authentication against the Dataiku DSS API.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.
  • No additional external services are required beyond the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the API key credential for Dataiku DSS is properly configured in n8n.
  • Required Parameter Missing: The node validates required parameters such as project keys or connection names depending on the operation. Make sure to provide all mandatory inputs.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify the Dataiku DSS server URL and API key validity.
  • Unexpected Response Format: If the API returns unexpected data or errors, check the Dataiku DSS API documentation for changes or deprecations.
  • Large Result Sets: When listing many connections, consider using pagination parameters (limit, page) in query parameters to avoid timeouts or large payloads.

Links and References

This summary focuses on the Connection resource and the List Connections Names operation, describing how the node constructs the API request, handles input properties, and formats the output accordingly.

Discussion