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 Project Folder resource and the Get Project Folder Settings operation, the node retrieves the settings of a specified project folder within a Dataiku DSS instance.

Common scenarios where this node is beneficial include:

  • Automating retrieval of configuration details for project folders in Dataiku DSS.
  • Integrating project folder metadata into workflows for auditing or reporting.
  • Managing project folder settings programmatically as part of larger automation pipelines.

Practical example:

  • A user wants to fetch the settings of a particular project folder by its Folder ID to verify permissions or configurations before performing further automated actions.

Properties

Name Meaning
Folder ID The unique identifier of the project folder whose settings are to be retrieved.

Output

The output contains a JSON object representing the settings of the specified project folder. This includes all configuration details returned by the Dataiku DSS API for that folder's settings endpoint.

If the operation succeeds, the output will be an array with one element containing the JSON response from the API, structured according to Dataiku DSS's project folder settings schema.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication 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 services or environment variables are required beyond the API credentials.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node throws an error indicating missing Dataiku DSS API credentials.
  • Folder ID Required: The operation requires the Folder ID property; if omitted, the node will throw an error stating that the Folder ID is required.
  • API Request Errors: Network issues, incorrect server URL, or insufficient permissions can cause API request failures. The node surfaces these errors with messages prefixed by "Error calling Dataiku DSS API".
  • Invalid JSON Response: If the API returns a non-JSON response unexpectedly, the node attempts to handle it gracefully but may return raw text instead.

To resolve common errors:

  • Ensure the API credentials are correctly set up and have sufficient permissions.
  • Verify the Folder ID is correct and exists in the Dataiku DSS instance.
  • Check network connectivity and the correctness of the Dataiku DSS server URL.

Links and References

Discussion