Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Plugin resource and the List Plugin Usages operation, it retrieves information about how elements of a specified plugin are used within the Dataiku DSS environment.

Common scenarios where this node is beneficial include:

  • Auditing or analyzing plugin usage across projects.
  • Understanding dependencies or impact before updating or removing a plugin.
  • Gathering usage statistics for governance or compliance purposes.

Practical example:

  • A user wants to list all usages of a particular plugin by providing its Plugin ID and optional query parameters to filter or paginate results.

Properties

Name Meaning
Plugin ID The unique identifier of the plugin whose usages you want to list.
Query Parameters Optional key-value pairs to filter or modify the listing request. Examples include:
- active (boolean)
- activity (string)
- allUsers (boolean)
- archivePath (string)
- catalogName (string)
- codeEnvName (string)
- columnName (string)
- columns (string)
- connected (boolean)
- connectionName (string)
- containerExecConfigName (string)
- deletionMode (string, default "KEEP")
- destination (string)
- dropData (boolean)
- exportAnalysisModels (boolean, default true)
- exportManaged (boolean, default true)
- exportSavedModels (boolean, default true)
- exportUploads (boolean, default true)
- filePart (string)
- filter (string)
- folderId (string)
- folderRef (string)
- forceRebuildEnv (boolean)
- foreign (boolean)
- format (string)
- formatParams (string)
- fullClassName (string)
- fullReguess (boolean, default true)
- includeAllPartitions (boolean, default false)
- includeLibs (boolean, default false)
- limit (number, min 1, default 50): Max number of results to return
- maxDatasetCount (number, default 2000)
- metricLookup (string)
- minTimestamp (number, default 14)
- name (string)
- onlyMonitored (boolean, default false)
- page (number, default 1)
- partition (string)
- partitions (string)
- path (string)
- peek (boolean, default false)
- predictionType (string)
- projectFolderId (string)
- projectKey (string)
- publishedProjectKey (string)
- publishedServiceId (string)
- purpose (string, default "GENERIC_COMPLETION")
- remote (string)
- removeIntermediate (boolean, default true)
- reassignTo (string)
- resultsPerPage (number, default 10000)
- ruleId (string)
- schemaName (string)
- stepId (string)
- tags (string)
- targetVariable (string)
- timeseriesIdentifiers (string)
- timeVariable (string)
- triggerId (string)
- triggerRunId (string)
- trustForEverybody (boolean, default false)
- type (string)
- versions (string)
- wait (boolean, default true)
- withScenarios (boolean, default false)

(Note: The above query parameters are generic options available for filtering or modifying the API request; not all may be applicable or required for the List Plugin Usages operation.)

Output

The output is an array of JSON objects representing the plugin usage information returned by the Dataiku DSS API. Each object contains details about where and how elements of the specified plugin are used.

If the response includes binary data (not typical for this operation), it would be provided as binary content in the output, but for the List Plugin Usages operation, the output is JSON.

Dependencies

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

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 Parameter Errors: The node validates required parameters such as Plugin ID. If these are missing, it will throw errors indicating which parameter is required.
  • API Request Failures: Network issues, incorrect server URL, or invalid API keys can cause request failures. Verify the server address and API key validity.
  • Unexpected Response Format: If the API returns unexpected data or errors, check the plugin ID and query parameters for correctness.
  • Rate Limits or Permissions: Insufficient permissions or rate limits on the Dataiku DSS API might cause errors. Ensure the API key has appropriate access rights.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion