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 Macro resource and the List Macros operation, it retrieves a list of macros available in a specified project.

Common scenarios where this node is beneficial include automating workflows that require interaction with Dataiku DSS projects, such as managing macros programmatically, integrating macro data into other systems, or orchestrating complex data pipelines that depend on macro execution results.

For example, a user might want to list all macros in a project to dynamically select one for execution in a subsequent step or to audit available macros for governance purposes.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project from which to list macros.

Note: For the "List Macros" operation under the "Macro" resource, only the "Project Key" property is required to specify the target project.

Output

The node outputs an array of JSON objects representing the macros retrieved from the Dataiku DSS project. Each object corresponds to a macro's details as returned by the Dataiku DSS API.

  • The output is provided in the json field of each item.
  • No binary data is produced for this operation.

Example output structure (simplified):

[
  {
    "id": "macro_1",
    "name": "Example Macro",
    "description": "Description of the macro",
    "createdAt": "2023-01-01T12:00:00Z",
    ...
  },
  {
    "id": "macro_2",
    "name": "Another Macro",
    "description": "Another macro description",
    "createdAt": "2023-02-01T12:00:00Z",
    ...
  }
]

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires an API key credential 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.
  • No additional environment variables are needed beyond the configured credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials (server URL and API key) are properly set up in n8n.
  • Project Key Required: The "Project Key" must be provided; otherwise, the node will throw an error indicating it is required.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credentials.
  • Unexpected Response Format: If the API response cannot be parsed as JSON, check if the Dataiku DSS API endpoint is returning valid data or if there are permission issues.

Links and References


This summary focuses on the "Macro" resource and the "List Macros" operation as requested, based on static analysis of the provided source code and input properties.

Discussion