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 Dataiku DSS resources. Specifically for the Workspace resource and the Update Workspace Settings operation, it allows updating settings of an existing workspace identified by its workspace key.

Common scenarios where this node is beneficial include automating workspace configuration updates as part of data science workflows, managing workspace properties programmatically, or integrating workspace management into larger automation pipelines.

For example, you might use this node to update access permissions, change workspace metadata, or modify other configurable settings of a workspace without manual intervention in the Dataiku DSS UI.

Properties

Name Meaning
Workspace Key The unique identifier (key) of the workspace whose settings you want to update.
Request Body A JSON object containing the new settings to apply to the workspace.

The Request Body property should be structured according to the Dataiku DSS API specification for workspace settings update. It typically includes fields representing the settings you want to change.

Output

The node outputs the response from the Dataiku DSS API after attempting to update the workspace settings. The output is provided in the json field of the returned item and contains the updated workspace information or confirmation of the update.

If the API returns binary data (not typical for this operation), it would be available in the binary field, but for updating workspace settings, the output is expected to be JSON.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key token) 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.

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 the workspace key. If these are missing, it will throw descriptive errors. Make sure to provide all required inputs.
  • API Request Failures: Network issues, incorrect API keys, or insufficient permissions can cause API request failures. Check your network connectivity, verify API keys, and ensure the user has permission to update workspace settings.
  • Invalid JSON in Request Body: Ensure the JSON provided in the Request Body is well-formed and matches the expected schema for workspace settings.

Links and References


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

Discussion