Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

The 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 Publish Bundle operation, this node allows publishing a project bundle to the Project Deployer within Dataiku DSS.

This is useful in scenarios where you want to automate the deployment process of your Dataiku projects by programmatically publishing bundles from the design side to the deployer. For example, after creating or updating a project bundle, you can use this node to publish it automatically as part of a CI/CD pipeline or workflow automation.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project containing the bundle.
Bundle ID The identifier of the specific bundle to be published.
Query Parameters Optional additional query parameters that can modify the publish request behavior.

Details on Query Parameters (optional)

These are key-value pairs that can be added to the request URL to customize the publish action. Examples include flags like wait (boolean) to wait for the operation to complete, or other parameters supported by the Dataiku API for bundle publishing.

Output

The output of the node is a JSON array where each item corresponds to the response from the Dataiku DSS API call.

  • For the Publish Bundle operation, the JSON output contains the server's response confirming the publish action, which may include status information about the published bundle.
  • If the operation returns binary data (not typical for publish), it would be provided as binary output, but for publishing bundles, the output is JSON.
  • In case of errors, the node throws an error with details about what went wrong during the API call.

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 uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.
  • No additional external services are required beyond the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials. Ensure you have configured the API key credential properly.
  • Required Parameter Missing: The node validates required parameters such as Project Key and Bundle ID. If these are missing, it throws descriptive errors. Make sure all required fields are filled.
  • API Request Failures: Network issues, incorrect URLs, or insufficient permissions can cause API call failures. Check the error message for HTTP status codes or messages returned by the Dataiku DSS API.
  • Unexpected Response Format: If the API returns unexpected data, parsing errors might occur. This usually indicates an issue with the API or the request parameters.
  • Timeouts or Long Operations: Publishing bundles might take time; if using the wait parameter, consider potential timeouts in your environment.

Links and References


This summary focuses on the "Bundles Design-Side" resource and the "Publish Bundle" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion