Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Data Collection resource and the Get Data Collection Settings operation, the node retrieves the configuration settings of a specified data collection within Dataiku DSS.

This functionality is useful when you want to programmatically access metadata or configuration details about a data collection, such as its properties or setup, without manually navigating the Dataiku DSS interface. For example, you might use this node to automate auditing of data collections or to dynamically adjust workflows based on data collection settings.

Properties

Name Meaning
Data Collection ID The unique identifier of the data collection whose settings you want to retrieve.

The node also supports other common parameters like projectKey (the project containing the data collection), but for this specific operation, the key input property is the Data Collection ID.

Output

The output of the node is a JSON object representing the settings of the specified data collection. This includes all configuration details returned by the Dataiku DSS API endpoint for data collection settings.

If the operation involves downloading files or binary content (not applicable for this operation), the node would output binary data accordingly, but for "Get Data Collection Settings," the output is purely JSON.

Example output structure (simplified):

{
  "id": "data_collection_id",
  "name": "Data Collection Name",
  "description": "Description of the data collection",
  "createdAt": "timestamp",
  "updatedAt": "timestamp",
  "settings": {
    // Various configuration fields specific to the data collection
  }
}

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authenticating with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • No additional external dependencies beyond the n8n environment and the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Required Parameter Errors: The node validates required parameters such as Data Collection ID and Project Key. Missing these will cause errors. Make sure to provide all required inputs.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credential validity.
  • Unexpected Response Format: If the API response cannot be parsed as JSON, it may indicate an issue with the API or unexpected data. Check the Dataiku DSS API documentation and server logs.

Links and References

This summary focuses on the "Data Collection" resource and the "Get Data Collection Settings" operation as requested, based on static analysis of the provided source code and input properties.

Discussion