Struct DesignAutomationClient 

pub struct DesignAutomationClient { /* private fields */ }

Design Automation API client

Implementations

impl DesignAutomationClient

pub async fn list_activities(&self) -> Result<Vec<String>>

List all activities

pub async fn create_activity( &self, request: CreateActivityRequest, ) -> Result<Activity>

Create a new activity

pub async fn create_activity_alias( &self, activity_id: &str, alias: &str, version: i32, ) -> Result<()>

Create an alias for an activity

pub async fn delete_activity(&self, id: &str) -> Result<()>

Delete an activity

impl DesignAutomationClient

pub async fn list_appbundles(&self) -> Result<Vec<String>>

List all app bundles

pub async fn create_appbundle( &self, id: &str, engine: &str, description: Option<&str>, ) -> Result<AppBundleDetails>

Create a new app bundle

pub async fn create_appbundle_alias( &self, bundle_id: &str, alias: &str, version: i32, ) -> Result<()>

Create an alias for an app bundle

pub async fn delete_appbundle(&self, id: &str) -> Result<()>

Delete an app bundle

pub async fn upload_appbundle( &self, upload_params: &UploadParameters, file_path: &Path, ) -> Result<()>

Upload an app bundle archive (.zip) using pre-signed S3 URL

After creating an app bundle, the response includes upload_parameters with an endpoint_url and form_data fields. This method POSTs the archive file as multipart/form-data to that pre-signed URL.

Arguments

• upload_params - The upload parameters from the create_appbundle response
• file_path - Path to the .zip archive to upload

impl DesignAutomationClient

pub fn nickname(&self) -> &str

Get the configured nickname (or “default”)

pub async fn effective_nickname(&self) -> Result<String>

Fetch the effective nickname from the DA API.

Returns the configured nickname if set, otherwise calls GET /forgeapps/me to get the actual owner name (usually the client_id).

pub async fn list_engines(&self) -> Result<Vec<String>>

List available engines

Returns a list of engine IDs (e.g., “Autodesk.Revit+2024”). Use get_engine to fetch full details for a specific engine.

pub async fn list_engines_detailed(&self) -> Result<Vec<Engine>>

List all engines with pagination, returning structured Engine objects.

The API returns engine IDs as strings. This method parses the ID to extract product name and version as the description.

impl DesignAutomationClient

pub async fn create_workitem( &self, activity_id: &str, arguments: HashMap<String, WorkItemArgument>, ) -> Result<WorkItem>

Create a work item (run an activity)

pub async fn list_workitems(&self) -> Result<Vec<WorkItem>>

List all workitems

The DA API requires a startAfterTime query parameter. Defaults to 24 hours ago if not specified.

pub async fn get_workitem_status(&self, id: &str) -> Result<WorkItem>

Get work item status

impl DesignAutomationClient

pub fn new(config: Config, auth: AuthClient) -> Self

Create a new Design Automation client

pub fn new_with_http_config( config: Config, auth: AuthClient, http_config: HttpClientConfig, ) -> Self

Create a new Design Automation client with custom HTTP config

Trait Implementations

impl Clone for DesignAutomationClient

fn clone(&self) -> DesignAutomationClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.