UiPath Documentation
sdk
latest
false
UiPath logo, featuring letters U and I in white

Developer guide

Last updated Mar 30, 2026

UiPath.Studio.Activities.Api

In this section you can find more information on how to build activities using UiPath.Studio.Activities.Api.

AssetRequestParameters​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.10.

Structure used to query the IAssetApiService in order to retrieve Orchestrator assets.

Properties​

TypeName
stringExpand
stringFilter
stringSelect
stringOrderBy
int?Top
int?Skip
bool?Count

DesignFeatureKeys​

List of feature keys to check if a feature is available.

Properties​

TypeNameValueIntroduced in
stringSettingsSettingsV1Studio 2019.10
stringSettingsV2SettingsV2Studio 2020.4
stringSettingsV3SettingsV3Studio 2021.10
stringThemeThemeV1Studio 2019.10
stringWizardsWizardsV1Studio 2019.10
stringWizardsV2WizardsV2Studio 2020.4
stringWizardsV3WizardsV3Studio 2020.4
stringWizardsV4WizardsV4Studio 2020.10
stringAccessProviderAccessProviderV1Studio 2019.10
stringAccessProviderV2AccessProviderV2Studio 2020.10
stringAccessProviderV3AccessProviderV3Studio 2020.10
stringTelemetryTelemetryV1Studio 2019.10
stringWorkflowAnalyzerWorkflowAnalyzerV1Studio 2019.10
stringWorkflowAnalyzerV2WorkflowAnalyzerV2Studio 2019.10.2
stringWorkflowAnalyzerV3WorkflowAnalyzerV3Studio 2019.10.3
stringProjectPropertiesProjectPropertiesV1Studio 2020.4
stringProjectPropertiesV2ProjectPropertiesV2Studio 2021.10
stringProjectPropertiesV3ProjectPropertiesV3Studio 2022.4
stringWorkflowAnalyzerV4WorkflowAnalyzerV4Studio 2020.4
stringWorkflowAnalyzerV5WorkflowAnalyzerV5Studio 2020.4.2
stringWorkflowAnalyzerV6WorkflowAnalyzerV6Studio 2020.10
stringWorkflowAnalyzerV7WorkflowAnalyzerV7Studio 2020.10
stringWorkflowAnalyzerV8WorkflowAnalyzerV8Studio 2020.10.3
stringWorkflowAnalyzerV9WorkflowAnalyzerV9Studio 2021.4
stringWorkflowAnalyzerV10WorkflowAnalyzerV10Studio 2021.10
stringWorkflowAnalyzerV11WorkflowAnalyzerV11Studio 2022.4
stringWorkflowAnalyzerV12WorkflowAnalyzerV12Studio 2022.4
stringWorkflowAnalyzerV13WorkflowAnalyzerV13Studio 2022.4
stringScopedActivitiesScopedActivitiesV1Studio 2020.4
stringActivitySynonymsActivitySynonymsV1Studio 2021.10
stringActivityTriggersActivityTriggersV1Studio 2022.4
stringAttendedActivitiesAttendedActivitiesV1Studio 2021.10
stringInstallExtensionsInstallExtensionsV1Studio 2020.4
stringInstallExcelAddInInstallExcelAddInV1Studio 2020.10
stringActivityFactoryActivityFactoryV1Studio 2020.10
stringActivityFactoryV2ActivityFactoryV2Studio 2020.10
stringActivityFactoryV3ActivityFactoryV3Studio 2021.4
stringActivityFactoryV4ActivityFactoryV4Studio 2022.4
stringStudioDesignSettingsStudioDesignSettingsV1Studio 2020.10
stringStudioDesignSettingsV2StudioDesignSettingsV2Studio 2021.10
stringExpressionServiceExpressionServiceV1Studio 2020.10
stringDesignTimeExpressionExpanderServiceDesignTimeExpressionExpanderServiceV1Studio 2021.10
stringExclusiveScopedActivitiesExclusiveScopedActivitiesV1Studio 2020.10
stringMockingCapabilitiesMockingCapabilitiesV1Studio 2020.10
stringMockingCapabilitiesV2MockingCapabilitiesV2Studio 2020.10
stringObjectRecorderHighlightObjectRecorderHighlightStudio 2021.10
stringObjectRecorderCurrentElementsObjectRecorderCurrentElementsStudio 2021.10
stringObjectRepositoryObjectRepositoryV1Studio 2020.10
stringSimpleObjectRepositorySimpleObjectRepositoryV1Studio 2021.10
stringOrganizationalSettingsOrganizationalSettingsV1Studio 2020.10.3
stringWindowOperationsWindowOperationsV1Studio 2021.4
stringWindowOperationsV2WindowOperationsV2Studio 2021.4
stringPackageBindingsPackageBindingsV1Studio 2021.4
stringPackageBindingsV2PackageBindingsV2Studio 2021.10
stringPackageBindingsV3PackageBindingsV3Studio 2022.4
stringOrchestratorApiOrchestratorApiV1Studio 2021.10
stringLicenseApiLicenseApiV1Studio 2021.10
stringBusyServiceBusyServiceV1Studio 2021.10
stringModernClassicSettingModernClassicSettingV1Studio 2021.10
stringAutoCaptureElementsAutoCaptureElementsStudio 2021.10

Remarks​

You can check if a feature is available by invoking the IHasFeature.HasFeature method using the key.

IAssetApiService​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.10.

Exposes the API for performing asset-related operations.

Methods​

Task<IEnumerable<string>> GetAssets(int top, string folder = null)​

Returns a list of strings representing the asset names in the specified folder. If a folder is not specified, the default folder is used.

Parameter TypeParameter NameRemarks
inttopThe number of assets to retrieve.
stringfolderThe folder in which the assets are defined. If null, all the assets visible to the current users will be retrieved.
Task<IEnumerable<string>> GetAssets(AssetRequestParameters requestParameters, string folder = null)​

Returns a list of strings representing the asset names in the specified folder. If a folder is not specified, the default folder is used.

Parameter TypeParameter NameRemarks
AssetRequestParametersrequestParametersAdvanced query parameters. See AssetRequestParameters.
stringfolderThe folder in which the assets are defined. If null, all the assets visible to the current users will be retrieved.
Task<IEnumerable<string>> GetAssetFolders(int top)​

Returns the list of accessible folders.

Parameter TypeParameter NameRemarks
inttopThe number of folders to retrieve.

IExtensionsInstallerService​

A way to install extensions from an activities package.

Methods​

void InstallExtension(string extensionName)​

Exposes installed extensions to activities.

Parameter TypeParameter NameRemarks
stringextensionNameThe name of the extension.
void InstallExcelAddIn()​

Triggers the installation process for the UiPath Excel Add-in for StudioX.

IOrchestratorApiService​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.10.

Top-level wrapper for Orchestrator-related operations. Exposed in IWorkflowDesignApi.

Properties​

TypeNameDescription
IAssetApiServiceAssetApiServiceA reference to an asset-related Orchestrator API.

IOrganizationalSettingsService​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.4.

Interface that describes how to read organizational settings.

Methods​

Task<Dictionary<string, object>> GetSettingsAsync(IEnumerable<string> keys, CancellationToken ct = default(CancellationToken))​

Retrieves multiple organizational settings from a data source and returns a map of the keys found and their values.

Parameter TypeParameter NameRemarks
IEnumerable<string>keysAn enumeration of organizational setting keys.
CancellationTokenctA dictionary which maps each of the found keys and its value.

IRegisterAnalyzerConfiguration​

Component called by the analyzer application in each rule assembly, in order to configure the host analyzer.

Methods​

void Initialize(IAnalyzerConfigurationService workflowAnalyzerConfigService)​

Offers an injection point to the implementing assembly in order to access IAnalyzerConfigurationService capabilities.

Parameter TypeParameter NameRemarks
IAnalyzerConfigurationServiceworkflowAnalyzerConfigServiceA reference to IAnalyzerConfigurationService to use in order to register rules.

IRegisterWorkflowDesignApi​

Workflow designer API registration. It follows the same pattern as IRegisterMetadata. Studio will scan the types in your assembly for implementations of this interface. If an implementation is found, an instance is created by Studio and the API instance is handed through IRegisterWorkflowDesignApi.Initialize(IWorkflowDesignApi.

Note:

Older Studio versions that do not ship with the API will not be able to load your assembly. If you want to keep the compatibility with the older Studio versions, instead of implementing this interface, add an Initialize(object) method on the implementation of IRegisterMetadata that Studio will discover through reflection. Cast the object parameter to IWorkflowDesignApi on your side. The same IWorkflowDesignApi instance may be retrieved from the designer context through GetService.

Methods​

void Initialize(IWorkflowDesignApi api)​

Register the API instance.

Parameter TypeParameter NameRemarks
IWorkflowDesignApiapiA reference to IWorkflowDesignApi to use in order to access Studio features.

IStudioDesignSettingsService​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.4.

Interface for functionality related to the Studio Designer panel.

Properties​

TypeNameRemarks
boolModernBehaviorIf set to true, the Modern Design Experience is enabled.
boolUseConnectionServiceIf set to true, Integration Service connections are enabled by default. Requires Studio 2021.10 or later.

IWindowOperationsService​

Note:

This feature was introduced in UiPath.Studio.Activities.Api v21.4.

The entry point for window-related operations.

Methods​

IntPtr GetMainWindowHandle()​

Returns a handle to the main Studio window.

void MinimizeMainWindow()​

Minimizes the main Studio window.

void MaximizeMainWindow()​

Maximizes the main Studio window.

void RestoreMainWindow()​

Restores the main Studio window.

void DisableMainWindow()​

Disables the main Studio window.

void EnableMainWindow()​

Enables the main Studio window.

IWorkflowDesignApi​

Entry point into the API. You can obtain an instance of this interface by implementing IRegisterWorkflowDesignApi or by adding a void Initialize(object) in your implementation of IRegisterMetadata interface.

Inheritance​

IHasFeature > IWorkflowDesignApi

Properties​

TypeNameAccessors
IOrganizationalSettingsServiceOrganizationalSettingsget
IActivitiesSettingsServiceSettingsget
ITelemetryServiceTelemetryget
IThemeServiceThemeget
IWizardsServiceWizardsget
IAccessProviderAccessProviderget
IProjectPropertiesServiceProjectPropertiesServiceget
IScopedActivitiesServiceScopedActivitiesServiceget
IActivitySynonymServiceActivitySynonymServiceget
IAttendedActivityServiceAttendedActivityServiceget
IDesignTimeExpressionExpanderServiceDesignTimeExpressionExpanderServiceget
IActivityFactoryRepositoryActivityFactoryget
ILibraryServiceObjectLibraryget
IExtensionsInstallerServiceExtensionsInstallerServiceget
IStudioDesignSettingsServiceStudioDesignSettingsget
IExpressionServiceExpressionServiceget
IExclusiveScopedActivitiesServiceExclusiveScopedActivitiesServiceget
IMockActivityServiceMockActivityServiceget
IWindowOperationsServiceWindowOperationsget
IPackageBindingsServicePackageBindingsget
ILicenseApiServiceLicenseApiServiceget
IStudioBusyServiceBusyServiceget
IActivityTriggerServiceActivityTriggerServiceget

Remarks​

This API is available in both Studio and Workflow Analyzer processes.

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated