Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

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 Bundles Design-Side resource and the Download Bundle operation, the node allows downloading an exported project bundle archive from a specified project in Dataiku DSS.

Typical use cases include:

  • Automating the retrieval of project bundles for backup or deployment purposes.
  • Integrating Dataiku DSS project bundles into CI/CD pipelines.
  • Downloading bundles for offline analysis or transfer between environments.

For example, a user can specify a project key and a bundle ID to download the corresponding exported bundle archive as a binary file, which can then be saved or processed further in their workflow.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project containing the bundle to download.
Bundle ID The identifier of the specific exported bundle to download from the project.

These properties are required to identify the exact bundle archive to retrieve.

Output

The output contains the downloaded bundle archive as binary data under the binary.data field. The binary content represents the zipped archive of the exported bundle from the Dataiku DSS project.

The filename for the binary data is set to "bundle_design.zip" to reflect the nature of the content.

Example output structure (conceptual):

{
  "binary": {
    "data": {
      "data": "<Buffer ...>",  // Binary content of the bundle zip archive
      "fileName": "bundle_design.zip"
    }
  }
}

If the request fails or no content is returned, the node will throw an error or return a status message accordingly.

Dependencies

  • Requires valid Dataiku DSS API credentials, including the DSS server URL and an API key.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API.
  • No additional external services are needed beyond access to the Dataiku DSS instance.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node throws an error indicating missing credentials.
  • Required Parameter Missing: The node validates that both Project Key and Bundle ID are provided; otherwise, it throws an error specifying the missing parameter.
  • HTTP Request Failures: Network issues, incorrect server URL, or insufficient permissions may cause API call failures. Check connectivity and API key permissions.
  • Unexpected Response Format: If the response is not a valid binary or JSON, parsing errors may occur. Ensure the requested bundle exists and the API endpoint is correct.

Links and References

This summary focuses on the Bundles Design-Side resource and the Download Bundle operation as requested.

Discussion