Dataiku DSS

Use the Dataiku DSS API

Actions364

Continuous Activity Actions
- Stop Continuous Activity
- Get Continuous Activities Status
- List Latests Continuous Activities
- Start Continuous Activity
Dataset Actions
- Get Last Metric Values
- Get Metadata
- Get Schema
- Get Single Metric History
- List Datasets
- List Partitions
- Compute Metrics
- Create Dataset
- Create Managed Dataset
- Delete Data
- Delete Dataset
- Execute Tables Import
- Get Column Lineage
- Get Data
- Get Data - Alternative Version
- Get Dataset Settings
- Get Full Info
- List Tables
- List Tables Schemas
- Prepare Tables Import
- Run Checks
- Set Metadata
- Set Schema
- Synchronize Hive Metastore
- Update Dataset Settings
- Update From Hive Metastore
API Service Actions
- Delete Package
- Download Package Archive
- Generate Package
- List API Services
- List Packages
- Publish Package
Bundles Automation-Side Actions
- Activate Bundle
- Create Project From Bundle
- Create Project From Bundle With Archive
- Import Bundle From Archive File
- List Imported Bundles
- Preload Bundle
- Upload Bundle
Bundles Design-Side Actions
- Create Bundle
- Delete Exported Bundle
- Download Bundle
- Get Bundle Details
- List Exported Bundles
- Publish Bundle
Connection Actions
- Create Connection
- Delete Connection
- Get Connection
- List Connections Names
- Update Connection
Dashboard Actions
- Create Dashboard
- Delete Dashboard
- Export Dashboard
- Get Dashboard
- List Dashboards
- Update Dashboard
Data Collection Actions
- Create Data Collection
- Create Data Collection Object
- Delete Data Collection
- Delete Dataset From Data Collection
- Get Data Collection Objects
- Get Data Collection Settings
- Update Data Collection Settings
Data Quality Actions
- Compute Rules on Specific Partition
- Create Data Quality Rules Configuration
- Delete Rule
- Get Data Quality Project Current Status
- Get Data Quality Project Timeline
- Get Data Quality Rules Configuration
- Get Dataset Current Status
- Get Dataset Current Status per Partition
- Get Last Outcome on Specific Partition
- Get Last Rule Results
- Get Rule History
- Update Rule Configuration
DSS Administration Actions
- Delete Tag
- Get Category
- Get Log
- Get Tag
- Save General Settings
- Append Entry to Audit Trail
- Create Category
- Create Tag
- Delete Category
- Save Variables
- Set Current License
- Update Category
- Update Tag
Job Actions
- Run Job
- Abort Job
- Get Job Logs
- Get Job Status
- List Latest Jobs
Library Actions
- Add Folder
- Delete File
- Download File
- List Files
- Move File or Folder
- Rename File or Folder
- Upload File
Dataset Statistic Actions
- Create Worksheet
- Delete Worksheet
- Get Worksheet
- List Worksheets
- Run Card
- Run Computation
- Update Worksheet
Discussion Actions
- Create Discussion
- Get Discussion
- List Discussions
- Reply Discussion
- Update Discussion
Flow Documentation Actions
- Download Flow Documentation
- Generate Flow Documentation From Custom Template
- Generate Flow Documentation From Default Template
- Generate Flow Documentation From File Template
Insight Actions
- Create Insight
- Delete Insight
- Get Insight
- List Insights
- Update Insight
Internal Metric Actions
- List Internal Metrics
LLM Mesh Actions
- List Available LLMs
- Perform Completions on a LLM
- Perform Embeddings on a LLM
Machine Learning - Lab Actions
- Delete Visual Analysis
- Deploy Trained Model to Flow
- Download Model Documentation of Trained Model
- Generate Model Documentation From Custom Template
- Start Training ML Task
- Update User Metadata for Trained Model
- Update Visual Analysis
- Adjust Forecasting Parameters and Algorithm
- Compute Partial Dependencies of Trained Model
- Compute Subpopulation Analysis of Trained Model
- Create ML Task
- Create Visual Analysis
- Create Visual Analysis and ML Task
- Generate Model Documentation From Default Template
- Generate Model Documentation From File Template
- Get ML Task Settings
- Get ML Task Status
- Get Model Snippet
- Get Partial Dependencies of Trained Model
- Get Scoring Jar of Trained Model
- Get Scoring PMML of Trained Model
- Get Subpopulation Analysis of Trained Model
- Get Trained Model Details
- Get Visual Analysis
- List ML Tasks of Project
- List ML Tasks of Visual Analyses
- List Visual Analyses
- Reguess ML Task
Machine Learning - Saved Model Actions
- Compute Partial Dependencies of Version
- Get Version Scoring PMML
- Get Version Snippet
- Import MLflow Version From File or Path
- List Saved Models
- List Versions
- Set Version Active
- Compute Subpopulation Analysis of Version
- Create Saved Model
- Delete Version
- Download Model Documentation of Version
- Evaluate MLflow Model Version
- Generate Model Documentation From Custom Template
- Generate Model Documentation From Default Template
- Generate Model Documentation From File Template
- Get MLflow Model Version Metadata
- Get Partial Dependencies of Version
- Get Saved Model
- Get Subpopulation Analysis of Version
- Get Version Details
- Get Version Scoring Jar
- Set Version User Meta
- Update Saved Model
Long Task Actions
- Abort Task
- Get Running Task State
- List Tasks in Progress
Machine Learning - Experiment Tracking Actions
- Clean Project
- Create Virtual Dataset
- Garbage Collect
- List Models for a Run
- Set Inference Information
Macro Actions
- Abort Macro
- Get Macro
- Get Run Macro Results
- Get Run Macro State
- List Macros
- Run Macro
Plugin Actions
- Download Plugin
- Fetch From Git Remote
- Get File Detail From Plugin
- Get Git Remote Info
- Get Plugin Settings
- Install Plugin From Git
- Install Plugin From Store
- List Files in Plugin
- List Git Branches
- List Plugin Usages
- Move File or Folder in Plugin
- Add Folder to Plugin
- Create Development Plugin
- Create Plugin Code Env
- Delete File From Plugin
- Delete Git Remote Info
- Delete Plugin
- Download File From Plugin
- Move Plugin to Dev Environment
- Pull From Git Remote
- Push to Git Remote
- Rename File or Folder in Plugin
- Reset to Local Head State
- Reset to Remote Head State
- Set Git Remote Info
- Set Plugin Settings
- Update Plugin Code Env
- Update Plugin From Git
- Update Plugin From Store
- Update Plugin From Zip Archive
- Upload File to Plugin
- Upload Plugin
Project Deployer Actions
- Get Deployment Settings
- Get Deployment Status
- Create Deployment
- Create Infra
- Create Project
- Delete Bundle
- Delete Deployment
- Delete Infra
- Delete Project
- Get Deployment
- Get Deployment Governance Status
- Get Infra
- Get Infra Settings
- Get Project
- Get Project Settings
- Save Deployment Settings
- Save Infra Settings
- Save Project Settings
- Update Deployment
- Upload Bundle
SQL Query Actions
- Start Query
- Stream Query
- Verify Query
Wiki Actions
- Update Article
- Create Article
- Get Article
- Get Wiki
- Update Wiki
Managed Folder Actions
- Create Managed Folders
- Delete File From Managed Folder
- Delete Managed Folder
- Download File From Managed Folder
- Get Managed Folder Settings
- List Files in Managed Folder
- List Managed Folder
- Update Managed Folder Settings
- Upload File in Managed Folder
Meaning Actions
- Create Meaning
- Get Meaning
- Update Meaning
Model Comparison Actions
- Create Model Comparison
- Delete Model Comparison
- Get Model Comparison
- List Model Comparisons
- Update Model Comparison
Notebook Actions
- Clear Jupyter Notebook Outputs
- Create Jupyter Notebook
- Delete Jupyter Notebook
- Get Jupyter Notebook
- List Jupyter Notebook Names
- List Jupyter Notebook Sessions
- Stop Jupyter Notebook Session
- Update Jupyter Notebook
Project Actions
- Create Project
- Delete Project
- Duplicate Project
- Export Project
- Get Project Metadata
- Get Project Permissions
- Get Project Tags
- Get Project Variables
- List Projects
- Push to Git Remote
- Update Project Metadata
- Update Project Permissions
- Update Project Tags
- Update Project Variables
Project Folder Actions
- Create Sub Project Folder
- Delete Project Folder
- Get Project Folder
- Get Project Folder Settings
- Move Project
- Move Project Folder
- Update Project Folder Settings
Recipe Actions
- Create Recipe
- Delete Recipe
- Get Recipe Metadata
- Get Recipe Settings
- List Recipes
- Set Recipe Metadata
- Update Recipe Settings
Scenario Actions
- Abort Scenario
- Create Scenario
- Delete Scenario
- Get Details for Run
- Get Last Runs
- Get Run From Trigger Run
- Get Run of a Trigger
- Get Scenario
- Get Scenario Logs
- Get Scenario Payload
- Get Scenario Status
- List Scenarios
- Run Scenario
- Update Basic Scenario Settings
- Update Scenario Payload
- Update Scenario Settings
Security Actions
- Create Code Env
- Create Group
- Create User
- Delete Code Env
- Delete Group
- Delete User
- Get Code Env
- Get Group
- Get User
- Get User Last Activity
- List Users
- Provision Users
- Resync Multiple Users
- Resync User
- Update Code Env
- Update Code Env Packages
- Update Group
- Update Jupyter Integration
- Update User
Streaming Endpoint Actions
- Create Managed Streaming Endpoint
- Create Streaming Endpoint
- Delete Streaming Endpoint
- Get Streaming Endpoint Schema
- Get Streaming Endpoint Settings
- List Streaming Endpoints
- Set Streaming Endpoint Schema
- Update Streaming Endpoint Settings
Webapp Actions
- Get Webapp
- Get Webapp Backend State
- List Webapps
- Restart Webapp Backend
- Stop Webapp Backend
- Trust Webapp
- Update Webapp
Workspace Actions
- Create Workspace
- Create Workspace Object
- Delete Workspace
- Delete Workspace Object
- Get Workspace Objects
- Get Workspace Settings
- Update Workspace Settings

Overview

This node integrates with the Dataiku DSS API, enabling automation and management of various Dataiku DSS resources. Specifically, for the "Create Project From Bundle With Archive" operation under the "Bundles Automation-Side" resource, it allows users to create a new project in Dataiku DSS from an existing bundle archive. This is useful for automating project creation workflows where projects are packaged as bundles and need to be instantiated programmatically.

Common scenarios include:

Automating deployment pipelines by creating projects from pre-built bundles.
Migrating or replicating projects across different Dataiku DSS instances.
Integrating Dataiku DSS project creation into larger data orchestration workflows.

Example: Automatically create a new Dataiku DSS project from a bundle archive stored in your environment, triggered by an external event or schedule.

Properties

Name	Meaning
Query Parameters	A collection of optional query parameters that can be added to the API request URL. Includes many possible keys such as `archivePath`, `projectKey`, `wait`, `withScenarios`, etc., allowing fine control over the creation process.
projectKey	The key identifier of the project to create or target.
archivePath	Path to the archive file containing the bundle to use for project creation.
wait	Boolean flag indicating whether to wait for the project creation process to complete before returning. Defaults to true.
withScenarios	Boolean flag indicating whether to include scenarios when creating the project from the bundle. Defaults to true.
exportAnalysisModels	Boolean flag to export analysis models during the bundle processing. Defaults to true.
exportManaged	Boolean flag to export managed datasets during the bundle processing. Defaults to true.
exportSavedModels	Boolean flag to export saved models during the bundle processing. Defaults to true.
exportUploads	Boolean flag to export uploaded files during the bundle processing. Defaults to true.

Note: The full list of query parameters is extensive and includes many other options related to project configuration, folder IDs, deletion modes, and more, providing detailed customization of the project creation process.

Output

The node outputs the JSON response returned by the Dataiku DSS API after attempting to create the project from the bundle archive. The output structure depends on the API response but typically includes details about the created project or status information.

If the operation involves downloading files (not applicable here), binary data would be prepared accordingly, but for this 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 beyond Dataiku DSS are required.

Troubleshooting

Missing Credentials Error: If the API credentials are not provided or invalid, the node will throw an error "Missing Dataiku DSS API Credentials". Ensure you have configured the API key credential correctly.
Required Parameter Missing: The node validates required parameters like projectKey and others depending on the operation. If missing, it throws errors specifying which parameter is required.
API Request Failures: Errors from the Dataiku DSS API (e.g., network issues, permission denied, invalid bundle archive) will be surfaced as node errors with messages prefixed by "Error calling Dataiku DSS API".
Timeouts: If wait is set to true, the node waits for the project creation to complete; if the process takes too long, consider setting wait to false or increasing timeout settings externally.
Invalid Bundle Archive: Ensure the archive path or file used is a valid Dataiku DSS bundle archive compatible with the target DSS version.

Links and References

This summary focuses on the "Create Project From Bundle With Archive" operation within the "Bundles Automation-Side" resource, describing its purpose, input properties, output, dependencies, and common troubleshooting points based on static code analysis.

Dataiku DSSInstall