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 Library resource and the Rename File or Folder operation, it allows renaming files or folders within a project's library in Dataiku DSS.

Common scenarios where this node is beneficial include:

  • Organizing project libraries by renaming files or folders to follow naming conventions.
  • Automating library maintenance tasks such as renaming outdated or incorrectly named files/folders.
  • Integrating with workflows that require dynamic renaming of library contents based on external inputs or processing results.

Example use case:

  • A data engineering workflow that uploads new scripts or datasets to the library and then renames them according to a timestamped naming scheme for version control.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the library to modify.
Request Body JSON object containing the details of the rename operation, typically specifying the current path and the new name for the file or folder.

Note: For the Rename File or Folder operation under the Library resource, the key input is the requestBody JSON which should include the necessary parameters for renaming (e.g., source path and target name).

Output

The node outputs the response from the Dataiku DSS API call:

  • If the rename operation is successful, the output JSON contains the API's confirmation or updated resource information.
  • If the operation involves downloading files or binary content (not typical for rename), the node would output binary data accordingly, but for rename, the output is JSON.
  • In case of errors, the node throws an error with details about the failure.

The output is structured as an array of JSON objects, each representing the result of the API call for each input item processed.

Dependencies

  • Requires valid Dataiku DSS API credentials, including the server URL and an API key with sufficient permissions to manage the project's library.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API.
  • No additional external services are required beyond access to the Dataiku DSS instance.

Troubleshooting

  • Missing Credentials Error: The node will throw an error if the Dataiku DSS API credentials are not provided or invalid. Ensure you have configured the API key credential correctly.
  • Project Key Required: Many operations, including library modifications, require the Project Key. Omitting this will cause an error.
  • Path Required: For renaming files or folders, the request body must specify the current path and the new name; missing these will cause the API call to fail.
  • API Errors: If the API returns an error (e.g., permission denied, resource not found), the node will throw an error with the message returned by the API. Check the API response and ensure the user has appropriate permissions.
  • Network Issues: Connectivity problems to the Dataiku DSS server will cause request failures. Verify network access and server availability.

Links and References


This summary focuses on the "Library" resource and the "Rename File or Folder" operation as requested.

Discussion