UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip rpa get-default-activity-xaml

Syntax and options for `uip rpa get-default-activity-xaml`, which returns the default XAML for an activity as it appears on the Studio designer.

uip rpa get-default-activity-xaml returns the XAML representation of an activity exactly as it would appear if dropped onto the designer surface for the first time — properties at default values, no expressions filled in. It is the inverse of activity discovery: once uip rpa find-activities has produced a class name or a TypeCache ID, this verb gives you the boilerplate XAML to paste into a workflow.

Provide exactly one of --activity-class-name (for standard activities shipped in NuGet packages) or --activity-type-id (for dynamic Integration Service activities). The verb runs through Studio, so a Windows runner is required.

Synopsis

uip rpa get-default-activity-xaml [--activity-class-name <string>] [--activity-type-id <string>] [--connection-id <string>] [--field-values <values>] [--event-operation <string>] [--object-name <string>]
uip rpa get-default-activity-xaml [--activity-class-name <string>] [--activity-type-id <string>] [--connection-id <string>] [--field-values <values>] [--event-operation <string>] [--object-name <string>]

Options

FlagDescription
--activity-class-name <string>Fully qualified class name of a non-dynamic activity, e.g. UiPath.Excel.Activities.ExcelApplicationScope. Mutually exclusive with --activity-type-id.
--activity-type-id <string>Unique TypeCache identifier for a dynamic (Integration Service) activity. Mutually exclusive with --activity-class-name.
--connection-id <string>Integration Service connection ID for dynamic activities. Only used together with --activity-type-id; if omitted, a fallback connection is resolved automatically.
--field-values <values>Literal values for the activity's input fields, only used with --activity-type-id. Repeatable name=value pairs (one flag occurrence per field; key=@file reads a value from a file), an inline JSON object string, or a JSON file via @fields.json / --field-values-file. When the values include the connector's prerequisite criteria fields (for example Jira's project and issue type), the returned configuration is re-resolved to carry the full expanded field schema — the same expansion Studio's designer performs when those fields are committed on the canvas. An unknown field name fails with the list of available fields.
--event-operation <string>The connector event operation to configure a persistence activity with — the event it waits for — so the returned configuration carries the resolved event fields. Only used with --activity-type-id, for persistence activities, and requires a live connection.
--object-name <string>The connector object a generic activity or event operates on — for example, the object whose CREATED/UPDATED event to wait for, or the object a generic connector activity targets. Only used with --activity-type-id and requires a live connection.

For the complete option list on your installed tool version, run:

uip rpa get-default-activity-xaml --help
uip rpa get-default-activity-xaml --help

Examples

# Default XAML for a standard activity
uip rpa get-default-activity-xaml \
  --activity-class-name UiPath.Excel.Activities.ExcelApplicationScope

# Default XAML for a dynamic Integration Service activity
uip rpa get-default-activity-xaml \
  --activity-type-id "salesforce.contact.create" \
  --connection-id 1f3b9c0e-7a25-4d8b-9b1f-9f6dd2c4f6d2
# Default XAML for a standard activity
uip rpa get-default-activity-xaml \
  --activity-class-name UiPath.Excel.Activities.ExcelApplicationScope

# Default XAML for a dynamic Integration Service activity
uip rpa get-default-activity-xaml \
  --activity-type-id "salesforce.contact.create" \
  --connection-id 1f3b9c0e-7a25-4d8b-9b1f-9f6dd2c4f6d2

See also

  • Synopsis
  • Options
  • Examples
  • Related
  • See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated