Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API, allowing users to interact programmatically with various Dataiku DSS resources. Specifically for the Streaming Endpoint resource and the Get Streaming Endpoint Schema operation, the node retrieves the schema definition of a specified streaming endpoint within a project.

Typical use cases include:

• Automating retrieval of streaming endpoint schemas for validation or documentation.
• Integrating streaming endpoint metadata into workflows for dynamic processing.
• Monitoring or auditing streaming endpoint configurations in Dataiku DSS projects.

Example: A user wants to fetch the schema of a streaming endpoint identified by its ID in a given project to understand the data structure it produces or consumes.

Properties

Output

The node outputs the JSON response from the Dataiku DSS API representing the schema of the specified streaming endpoint. This JSON typically includes details about the fields, types, and structure of the streaming data.

If the operation involves binary data (not applicable for this specific operation), the node would output the binary content accordingly.

Output example (conceptual):

{
  "fields": [
    {
      "name": "field1",
      "type": "string",
      "description": "Description of field1"
    },
    {
      "name": "field2",
      "type": "integer",
      "description": "Description of field2"
    }
  ],
  "metadata": {
    "streamingEndpointId": "abc123",
    "projectKey": "MY_PROJECT"
  }
}

Dependencies

• Requires an active connection to a Dataiku DSS instance.
• Needs valid API credentials including the DSS server URL and a user API key.
• The node uses HTTP requests to communicate with the Dataiku DSS REST API.
• No additional external libraries beyond those bundled with n8n are required.

Troubleshooting

• Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly configured in n8n.
• Required Parameters Missing: Errors like "Project Key is required" or "Streaming Endpoint ID is required" indicate that these inputs must be provided.
• 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 returns unexpected data or errors, check the streaming endpoint ID and project key correctness.
• Permission Issues: Ensure the API key has sufficient permissions to access the streaming endpoint schema.

Links and References

• Dataiku DSS API Documentation
• Streaming Endpoints in Dataiku DSS
• n8n Documentation - Creating Custom Nodes

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