Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to interact programmatically with various Dataiku DSS resources. Specifically for the Webapp resource and the Get Webapp operation, it retrieves detailed information about a specific web application within a given project in Dataiku DSS.

Common scenarios where this node is beneficial include:

  • Automating retrieval of webapp configurations or statuses as part of a larger workflow.
  • Integrating Dataiku DSS webapp data into external systems or dashboards.
  • Monitoring or auditing webapps programmatically without manual intervention.

For example, a user might use this node to fetch the current configuration or status of a webapp identified by its ID within a project, then use that data downstream in an automation pipeline.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project containing the webapp.
Webapp ID The unique identifier of the webapp to retrieve details for.

These properties are required to specify which webapp's information should be fetched from which project.

Output

The output of the node is a JSON object representing the webapp's details as returned by the Dataiku DSS API. This typically includes metadata and configuration information about the webapp.

If the operation involves downloading files (not applicable for Get Webapp), the node can output binary data representing those files. For the Get Webapp operation, the output is purely JSON.

Example output structure (simplified):

{
  "id": "webapp-id",
  "name": "Webapp Name",
  "description": "Description of the webapp",
  "status": "running",
  "configuration": {
    // Various configuration details
  },
  // Additional fields as provided by the API
}

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.

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 Missing: Errors like "Project Key is required" or "Webapp ID is required" indicate that these input parameters were not provided. Make sure to fill in these fields.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credential validity.
  • Unexpected Response Format: If the API response cannot be parsed as JSON, check if the Dataiku DSS server is returning errors or unexpected content.

Links and References

This summary focuses on the Webapp resource and the Get Webapp operation as requested, based on static analysis of the provided source code and property definitions.

Discussion