- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip is activities
Syntax and options for `uip is activities`, which lists the operations a connector exposes in Integration Service and builds local activity metadata and action-script type headers.
uip is activities lists the operations a connector exposes. Activities are the named actions (CreateTicket, ListAllRecords, etc.) that an automation can drive against a connector — they map onto HTTP methods and connector objects. list results are cached per-connector-and-tenant; pass --refresh to re-fetch. The metadata generate and script update verbs work on local files only: metadata generate compiles a minimal-metadata file into activity metadata, and script update writes a type header into an action script from that metadata.
Synopsis
uip is activities list <connector-key> [--triggers] [--refresh]
uip is activities metadata generate <min-file> [--out <file>]
uip is activities script update <script-file> --metadata <file>
uip is activities list <connector-key> [--triggers] [--refresh]
uip is activities metadata generate <min-file> [--out <file>]
uip is activities script update <script-file> --metadata <file>
Verbs
| Verb | Purpose |
|---|---|
list | List the activities a connector exposes. With --triggers, list trigger activities only. |
metadata generate | Generate activity metadata from a minimal-metadata (.min.json) file. |
script update | Update an action script's type header in place from its activity metadata. |
uip is activities list
List activities for a connector. By default, trigger activities are excluded; pass --triggers to list only triggers.
Arguments
| Name | Required | Purpose |
|---|---|---|
<connector-key> | yes | Connector key, for example uipath-zoho-desk. |
Options
| Short | Long | Value | Default | Description |
|---|---|---|---|---|
| — | --refresh | flag | off | Force re-fetch from the API, ignoring cache. |
| — | --triggers | flag | off | List trigger activities only. Switches Code to TriggerActivityList. |
Examples
uip is activities list uipath-zoho-desk
# Trigger activities only
uip is activities list uipath-zoho-desk --triggers
# Just the activity names
uip is activities list uipath-zoho-desk \
--output-filter '[].Name'
uip is activities list uipath-zoho-desk
# Trigger activities only
uip is activities list uipath-zoho-desk --triggers
# Just the activity names
uip is activities list uipath-zoho-desk \
--output-filter '[].Name'
Data shape (--output json)
{
"Code": "ActivityList",
"Data": [
{
"Name": "CreateTicket",
"DisplayName": "Create Ticket",
"Description": "Create a new ticket in Zoho Desk.",
"ObjectName": "create_ticket",
"MethodName": "POST",
"Operation": "N/A",
"IsCurated": "Yes"
},
{
"Name": "ListAllRecords",
"DisplayName": "List Records",
"Description": "Retrieve and list records from Zoho Desk.",
"ObjectName": "N/A",
"MethodName": "N/A",
"Operation": "List",
"IsCurated": "No"
}
]
}
{
"Code": "ActivityList",
"Data": [
{
"Name": "CreateTicket",
"DisplayName": "Create Ticket",
"Description": "Create a new ticket in Zoho Desk.",
"ObjectName": "create_ticket",
"MethodName": "POST",
"Operation": "N/A",
"IsCurated": "Yes"
},
{
"Name": "ListAllRecords",
"DisplayName": "List Records",
"Description": "Retrieve and list records from Zoho Desk.",
"ObjectName": "N/A",
"MethodName": "N/A",
"Operation": "List",
"IsCurated": "No"
}
]
}
With --triggers, the response uses Code: "TriggerActivityList" and the same per-row shape.
An empty result still succeeds, with an Instructions message. Without --triggers, a connector whose activities are all triggers returns an empty list and the message points to --triggers.
uip is activities metadata generate
Generate activity metadata from a minimal-metadata file. The minimal-metadata file (<name>.min.json) is the source you edit; the generated metadata file is derived from it. The command validates the generated metadata before writing it, so a file that fails validation leaves no output behind. To change the generated metadata, edit the minimal-metadata file and run the command again.
Arguments
| Name | Required | Purpose |
|---|---|---|
<min-file> | yes | Path to the <name>.min.json file. The file must contain an activity block. |
Options
| Short | Long | Value | Default | Description |
|---|---|---|---|---|
| — | --out | path | input path with .min.json replaced by .json | Output path. Required when <min-file> does not end in .min.json. |
Example
uip is activities metadata generate ./AddUsersToUsergroup.min.json
uip is activities metadata generate ./AddUsersToUsergroup.min.json
Data shape (--output json)
{
"Code": "ActivityMetadataGenerated",
"Data": {
"Out": "./AddUsersToUsergroup.json",
"Name": "AddUsersToUsergroup",
"Fields": 12,
"PrimaryKey": ["usergroup.id"]
}
}
{
"Code": "ActivityMetadataGenerated",
"Data": {
"Out": "./AddUsersToUsergroup.json",
"Name": "AddUsersToUsergroup",
"Fields": 12,
"PrimaryKey": ["usergroup.id"]
}
}
| Field | Description |
|---|---|
Out | Path of the generated metadata file. |
Name | Activity name. |
Fields | Number of fields in the generated metadata. |
PrimaryKey | Primary-key field names. Present only when the generated metadata declares a primary key. |
A missing or invalid input file, or metadata that fails validation, fails with ErrorCode: "invalid_metadata" and exit code 1.
uip is activities script update
Update an action script's type header in place from its activity metadata. The type header is a leading /* … */ comment block of type declarations that describes the script's inputs and outputs. If the script already starts with a block comment, the command replaces it; otherwise, it adds the header at the top of the file.
Arguments
| Name | Required | Purpose |
|---|---|---|
<script-file> | yes | Path to the action script (.js) to update. |
Options
| Short | Long | Value | Default | Description |
|---|---|---|---|---|
| — | --metadata | path | required | Path to the activity metadata JSON the type header is derived from, for example the output of metadata generate. |
Example
uip is activities script update ./AddUsersToUsergroup.js --metadata ./AddUsersToUsergroup.json
uip is activities script update ./AddUsersToUsergroup.js --metadata ./AddUsersToUsergroup.json
Data shape (--output json)
{
"Code": "ScriptUpdated",
"Data": { "Script": "./AddUsersToUsergroup.js", "Types": 4 }
}
{
"Code": "ScriptUpdated",
"Data": { "Script": "./AddUsersToUsergroup.js", "Types": 4 }
}
Types is the number of type declarations in the header. A missing script or metadata file, or a metadata file that is not valid JSON, fails with ErrorCode: "invalid_metadata" and exit code 1.
To run the updated script against a connection, use uip is resources run script.
Related
uip is connectors— find the connector key first.uip is resources— call the data plane behind these activities (describe,run).uip is triggers— full metadata for event-driven activities.