UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip is resources

Syntax and options for `uip is resources`, which lists, describes, and runs operations against connector data-plane objects.

uip is resources works with the runtime objects a connector addresses — tickets, contacts, records, files. list enumerates the connector's objects, describe returns the field schema and operations for one object, and run calls the connector's data plane (Create / List / Get / Update / Replace / Delete) or runs an action script against a connection. Every run verb requires --connection-id; the cached metadata reads (list, describe) accept it optionally to surface custom objects/fields.

Important:

The data-plane verb group is uip is resources run, not execute — uip is resources execute ... doesn't exist and fails with "unknown command".

Synopsis​

uip is resources <verb> [options]
uip is resources <verb> [options]

Verbs​

VerbPurpose
listList objects available on a connector; optionally filter by operation.
describeDescribe one object's operations and field schema.
runCall the connector's data plane (Create / List / Get / Update / Replace / Delete), or run an action script against a connection.

uip is resources list​

List objects available on a connector. Results depend on whether --connection-id is supplied — connection-scoped listings include custom objects; unscoped listings don't (the CLI surfaces a Warning in that case).

Arguments​

NameRequiredPurpose
<connector-key>yesConnector key, for example uipath-zoho-desk.

Options​

ShortLongValueDefaultDescription
—--operationenum—Filter by operation: List, Retrieve, Create, Update, Delete, Replace.
—--connection-idid—Scope to a specific connection (enables custom objects).
—--refreshflagoffForce re-fetch from the API, ignoring cache.

Examples​

uip is resources list uipath-zoho-desk

# Only objects that support a Create operation
uip is resources list uipath-zoho-desk --operation Create

# Connection-scoped listing — includes custom objects
uip is resources list uipath-zoho-desk \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001
uip is resources list uipath-zoho-desk

# Only objects that support a Create operation
uip is resources list uipath-zoho-desk --operation Create

# Connection-scoped listing — includes custom objects
uip is resources list uipath-zoho-desk \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

Data shape (--output json)​

{
  "Code": "ResourceList",
  "Data": [
    {
      "Name": "tickets",
      "DisplayName": "Tickets",
      "Path": "/tickets",
      "Type": "standard",
      "SubType": "standard",
      "Custom": "no",
      "Operations": ["List", "Retrieve", "Create"],
      "ElementKey": "uipath-zoho-desk"
    }
  ]
}
{
  "Code": "ResourceList",
  "Data": [
    {
      "Name": "tickets",
      "DisplayName": "Tickets",
      "Path": "/tickets",
      "Type": "standard",
      "SubType": "standard",
      "Custom": "no",
      "Operations": ["List", "Retrieve", "Create"],
      "ElementKey": "uipath-zoho-desk"
    }
  ]
}

Operations lists the operations the object supports (List, Retrieve, Create, Update, Delete, Replace). It is an empty array when the connector reports no operations for the object.

Without --connection-id, the response carries Warning: "Results may not include custom objects. Use --connection-id for connection-specific data.". An empty result still succeeds, with an Instructions message that names the connector key, or the operation when --operation filtered every object out.

uip is resources describe​

Describe an object's fields and operations. Without --operation, returns the list of available operations and a hint. With --operation, narrows to one operation and returns its parameters, request fields, and response fields.

Arguments​

NameRequiredPurpose
<connector-key>yesConnector key.
<object-name>yesObject name — the objectName from the activity's configuration JSON (for example, tickets). Find names with resources list. Addresses the object the same way under both --activity-version values (see below).

Options​

ShortLongValueDefaultDescription
—--connection-idid—Scope to a connection (enables custom fields; required together with --field).
—--operationenum—List, Retrieve, Create, Update, Delete, or Replace. Required together with --field.
—--activity-version1.0.0 | 4.0.01.0.0Which activity metadata endpoints to query — see Activity metadata versions below.
-f--fieldname=value—Parent-field value. Repeatable. Runs the connector's api-type ObjectAction (for example Jira's GenerateSchema, Salesforce's GenerateQuerySchema) and merges its custom-field response into requestFields. Requires both --connection-id and --operation. Not supported with --activity-version 4.0.0.
—--actionnameinferredExplicit api-type ObjectAction name (for example GenerateSchema). Optional — inferred from the --field names when omitted; pass it to disambiguate when more than one action could match.
—--refreshflagoffForce re-fetch from the API, ignoring cache. Cache is also automatically bypassed whenever --field is supplied, since a design-action response varies per parent-field combination.

Activity metadata versions​

--activity-version switches which Integration Service metadata endpoint describe queries:

  • 1.0.0 (default) — v3 elements endpoints, connection-scoped. Supports -f/--field design-action lookups.
  • 4.0.0 — v4 elements endpoints, not connection-scoped. Passing --connection-id alongside it is accepted but ignored (with a warning) since v4 doesn't need it for the fetch itself. -f/--field is rejected outright with --activity-version 4.0.0 — design-time ObjectActions are a v3-only, instance-scoped feature.

In both cases the <object-name> positional means the same thing — the object's name — so there's no addressing difference between the two versions, only which backend endpoint answers the call.

Examples​

# List operations available on this object (v3, default)
uip is resources describe uipath-zoho-desk tickets

# Field schema for the Create operation
uip is resources describe uipath-zoho-desk tickets --operation Create

# Required request fields, scripting-friendly
uip is resources describe uipath-zoho-desk tickets --operation Create \
    --output-filter 'requestFields[?required].name'

# Describe a 4.0.0 activity by object name (v4 elements endpoints)
uip is resources describe uipath-salesforce-slack add_users_to_usergroup \
    --activity-version 4.0.0

# Parent-field values (Jira: project + issue type → custom fields for that combination)
uip is resources describe uipath-atlassian-jira curated_create_issue \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f fields.project.key=ENGCE -f fields.issuetype.id=3

# Body-token parent field (Salesforce SOQL: query → response columns)
uip is resources describe uipath-salesforce-sfdc query_records \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f query="SELECT Id, Name FROM Account WHERE Status = 'Active'"
# List operations available on this object (v3, default)
uip is resources describe uipath-zoho-desk tickets

# Field schema for the Create operation
uip is resources describe uipath-zoho-desk tickets --operation Create

# Required request fields, scripting-friendly
uip is resources describe uipath-zoho-desk tickets --operation Create \
    --output-filter 'requestFields[?required].name'

# Describe a 4.0.0 activity by object name (v4 elements endpoints)
uip is resources describe uipath-salesforce-slack add_users_to_usergroup \
    --activity-version 4.0.0

# Parent-field values (Jira: project + issue type → custom fields for that combination)
uip is resources describe uipath-atlassian-jira curated_create_issue \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f fields.project.key=ENGCE -f fields.issuetype.id=3

# Body-token parent field (Salesforce SOQL: query → response columns)
uip is resources describe uipath-salesforce-sfdc query_records \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f query="SELECT Id, Name FROM Account WHERE Status = 'Active'"
Note:

If a -f/--field call comes back holding only the fields you supplied (none of the connection's own custom fields), the response also carries a Warning: one of the values you passed probably doesn't exist on that connection. Check it against the lookup for that field.

Data shape (--output json)​

Without --operation:

{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "tickets",
    "displayName": "Tickets",
    "elementKey": "uipath-zoho-desk",
    "availableOperations": [
      { "method": "GET", "name": "List", "description": "Search for Tickets", "path": "/tickets" },
      { "method": "POST", "name": "Create", "description": "Create a Tickets", "path": "/tickets" }
    ],
    "hint": "Use --operation <Create|List|Retrieve|Update|Delete|Replace> to see fields for a specific operation."
  }
}
{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "tickets",
    "displayName": "Tickets",
    "elementKey": "uipath-zoho-desk",
    "availableOperations": [
      { "method": "GET", "name": "List", "description": "Search for Tickets", "path": "/tickets" },
      { "method": "POST", "name": "Create", "description": "Create a Tickets", "path": "/tickets" }
    ],
    "hint": "Use --operation <Create|List|Retrieve|Update|Delete|Replace> to see fields for a specific operation."
  }
}

With --operation Create, the same Code: "ResourceMetadata" is returned, but instead of availableOperations the payload carries operation, parameters, requestFields, and responseFields.

With -f/--field (parent-field / design-action lookup), requestFields reflects the merged, connection-specific schema:

{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "curated_create_issue",
    "operation": { "method": "POST", "name": "Create" },
    "requestFields": [
      { "name": "fields.project.key", "required": true, "displayName": "Project" },
      { "name": "fields.issuetype.id", "required": true, "displayName": "Issue type" },
      { "name": "fields.summary", "required": true, "displayName": "Summary" },
      { "name": "fields.description", "required": false, "displayName": "Description" }
    ]
  }
}
{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "curated_create_issue",
    "operation": { "method": "POST", "name": "Create" },
    "requestFields": [
      { "name": "fields.project.key", "required": true, "displayName": "Project" },
      { "name": "fields.issuetype.id", "required": true, "displayName": "Issue type" },
      { "name": "fields.summary", "required": true, "displayName": "Summary" },
      { "name": "fields.description", "required": false, "displayName": "Description" }
    ]
  }
}

uip is resources run​

Call the connector's data plane, or run an action script against a connection. run itself is a group; the data-plane verbs are create, list, get, update, replace, and delete, and script runs an action script. Every verb requires --connection-id; create, update, and replace additionally require --body with a JSON request body. delete is destructive and requires -y, --yes — the CLI never prompts.

uip is resources run create   <connector-key> <object-name> --connection-id <id> --body <json> [--query <params>]
uip is resources run list     <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources run get      <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources run update   <connector-key> <object-name> --connection-id <id> --body <json> [--query <params>]
uip is resources run replace  <connector-key> <object-name> --connection-id <id> --body <json> [--query <params>]
uip is resources run delete   <connector-key> <object-name> --connection-id <id> -y, --yes [--query <params>]
uip is resources run script   --connection-id <id> --inline-script <source> | --script-ref <name> --connector-key <key> [--body <json>] [--query <params>] [--header <name=value>...]
uip is resources run create   <connector-key> <object-name> --connection-id <id> --body <json> [--query <params>]
uip is resources run list     <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources run get      <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources run update   <connector-key> <object-name> --connection-id <id> --body <json> [--query <params>]
uip is resources run replace  <connector-key> <object-name> --connection-id <id> --body <json> [--query <params>]
uip is resources run delete   <connector-key> <object-name> --connection-id <id> -y, --yes [--query <params>]
uip is resources run script   --connection-id <id> --inline-script <source> | --script-ref <name> --connector-key <key> [--body <json>] [--query <params>] [--header <name=value>...]

HTTP method mapping: create → POST, list → GET (collection), get → GET-by-id, update → PATCH, replace → PUT, delete → DELETE.

Arguments​

NameRequiredPurpose
<connector-key>yesConnector key.
<object-name>yesObject name (for example, tickets).

Shared options​

ShortLongValueDefaultDescription
—--connection-ididrequiredConnection used to authorize the data-plane call.
—--queryparams—Query parameters. Accepts key=value&key=value or a JSON object.
—--bodyJSON—Request body. Required for create, update, replace.
-y--yesflag—Required on delete only. Confirms this irreversible operation — the CLI never prompts.

Examples​

# Create a ticket
uip is resources run create uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"subject":"New issue","departmentId":"DEP-1"}'

# List tickets — first page
uip is resources run list uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

# Delete a ticket by ID — destructive, requires --yes
uip is resources run delete uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --query 'id=TK-1001' \
    --yes
# Create a ticket
uip is resources run create uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"subject":"New issue","departmentId":"DEP-1"}'

# List tickets — first page
uip is resources run list uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

# Delete a ticket by ID — destructive, requires --yes
uip is resources run delete uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --query 'id=TK-1001' \
    --yes

Data shape (--output json)​

{
  "Code": "ExecuteOperation",
  "Data": { "id": "TK-1001", "subject": "New issue", "status": "Open" }
}
{
  "Code": "ExecuteOperation",
  "Data": { "id": "TK-1001", "subject": "New issue", "status": "Open" }
}

list operations return { "items": [...] } and, when the backend signals more pages via Elements-Has-More / Elements-Next-Page-Token headers, include a Pagination object with HasMore and NextPageToken.

Failed calls surface with Failure, the HTTP status as Message, and the server body as Instructions.

An operation that requires file input (multipart upload) fails with ErrorCode: "invalid_argument", because resources run sends only a JSON --body. Run that operation in Studio Web.

uip is resources run script​

Run an action script against a connection. Integration Service resolves the connection's credential server-side, so the script never receives the token. Provide exactly one script source:

  • --inline-script takes JavaScript source, or a path ending in .js to read the script from a file.
  • --script-ref takes the reference of a published script. It requires --connector-key.

Passing neither, or both, fails with a validation error (exit code 3). A missing --connection-id fails the same way.

Options​
ShortLongValueDefaultDescription
—--connection-ididrequiredConnection the script runs against. Find it with uip is connections list <connector-key> --all-folders.
—--inline-scriptsource or .js path—JavaScript source, or a path ending in .js to read a file. A .js path that does not exist fails before the call.
—--script-refname—Reference of a published script.
—--connector-keykey—Connector key. Required with --script-ref.
—--bodyJSON—Script input, read by the script as context.request.body.
—--queryparams—Query parameters. Accepts key=value&key=value or a JSON object.
—--headername=value—Request headers as name=value. Accepts several values.
Examples​
# Run a local action script against a connection
uip is resources run script     --connection-id 849e85d8-1aa9-4d52-8bbd-20041c8f05d8     --inline-script ./ChannelArchive.js     --body '{"channel":"C0A66HP9KKM"}'

# Run a published script by reference (needs the connector key)
uip is resources run script     --connection-id 675e641b-70e1-401d-b652-568dfd03c1d2     --connector-key uipath-salesforce-slack     --script-ref list_usergroups     --query pageSize=1000
# Run a local action script against a connection
uip is resources run script     --connection-id 849e85d8-1aa9-4d52-8bbd-20041c8f05d8     --inline-script ./ChannelArchive.js     --body '{"channel":"C0A66HP9KKM"}'

# Run a published script by reference (needs the connector key)
uip is resources run script     --connection-id 675e641b-70e1-401d-b652-568dfd03c1d2     --connector-key uipath-salesforce-slack     --script-ref list_usergroups     --query pageSize=1000
Data shape (--output json)​
{
  "Code": "ScriptExecuted",
  "Data": {
    "Status": 200,
    "Headers": { "content-type": "application/json" },
    "Body": { "ok": true, "channel": "C0A66HP9KKM" }
  }
}
{
  "Code": "ScriptExecuted",
  "Data": {
    "Status": 200,
    "Headers": { "content-type": "application/json" },
    "Body": { "ok": true, "channel": "C0A66HP9KKM" }
  }
}

Status, Headers, and Body are the response the script produced. A vendor 4xx or 5xx status still returns Result: "Success". Read Data.Status to tell the outcome. The command fails only when the script cannot be read or Integration Service cannot be reached.

See also​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated