uip é recursos

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

uip is resources com os objetos de runtime que um conector aborda — tickets, contatos, registros, arquivos. list enumera os objetos do conector, describe retorna o esquema de campo e operações para um objeto e run chama o plano de dados do conector (Criar / Listar / Obter / Atualizar / Substituir / Excluir) contra uma conexão. Cada verbo run requer --connection-id; as leituras de metadados em cache (list, describe) aceitam-no opcionalmente para exibir objetos/campos personalizados.

Importante:

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

Resumo

uip is resources <verb> [options]

Verbo

Texto	Finalidade
list	Listar objetos disponíveis em um conector; opcionalmente, filtre por operação.
describe	Descreva as operações e o esquema de campo de um objeto.
run	Chame o plano de dados do conector (Criar / Listar / Obter / Atualizar / Substituir / Excluir).

uip é lista de recursos

Liste objetos disponíveis em um conector. Os resultados dependem de se --connection-id é fornecido — as listagens com escopo de conexão incluem objetos personalizados; listagens sem escopo não o fazem (a CLI revela um Warning nesse caso).

Argumentos

Name	Required	Finalidade
<connector-key>	sim	Chave de conector, por exemplo uipath-zoho-desk

Opções

Short	Long	Valor	Padrão	Description
—	--operation	ENUM	—	Filtrar por operação: List, Retrieve, Create, Update, Delete, Replace.
—	--connection-id	id	—	Escopo para uma conexão específica (habilita objetos personalizados).
—	--refresh	Bandeira	desativada	Força a nova busca da API, ignorando o cache.

Exemplos

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

Formato dos dados (--output json)

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

uip é descrição dos recursos

Descreva os campos e operações de um objeto. Sem --operation, retorna a lista de operações disponíveis e uma dica. Com --operation, restringe-se a uma operação e retorna seus parâmetros, campos de solicitação e campos de resposta.

Argumentos

Name	Required	Finalidade
<connector-key>	sim	Chave do conector.
<object-name>	sim	Object 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).

Opções

Short	Long	Valor	Padrão	Description
—	--connection-id	id	—	Scope to a connection (enables custom fields; required together with --field).
—	--operation	ENUM	—	List, Retrieve, Create, Update, Delete, or Replace. Required together with --field.
—	--activity-version	1.0.0 | 4.0.0	1.0.0	Which activity metadata endpoints to query — see Activity metadata versions below.
-f	--field	name=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.
—	--action	name	inferido	Explicit 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.
—	--refresh	Bandeira	desativada	Force 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.

Exemplos

# 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 'Data.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'"

Observação:

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.

Formato dos dados (--output json)

Sem --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."
  }
}

Com --operation Create, o mesmo Code: "ResourceMetadata" é retornado, mas em vez de availableOperations a carga carrega operation, parameters, requestFields e 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" }
    ]
  }
}

uip is resources run

Call the connector's data plane. run itself is a group; the actual verbs are create, list, get, update, replace, and delete. 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>
uip is resources run list     <connector-key> <object-name> --connection-id <id>
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>
uip is resources run replace  <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run delete   <connector-key> <object-name> --connection-id <id> -y, --yes [--query <params>]

Mapeamento de método HTTP: create → POST, list → GET (Coleção), get → GET-by-id, update → PATCH, replace → PUT, delete → DELETE.

Argumentos

Name	Required	Finalidade
<connector-key>	sim	Chave do conector.
<object-name>	sim	Nome do objeto (por exemplo, tickets).

Opções compartilhadas

Short	Long	Valor	Padrão	Description
—	--connection-id	id	necessário	Conexão usada para autorizar a chamada do plano de dados.
—	--query	Parâmetros	—	Parâmetros de consulta. Aceita key=value&key=value ou um objeto JSON.
—	--body	JSON	—	Corpo da solicitação. Obrigatório para create, update, replace.
-y	--yes	Bandeira	—	Required on delete only. Confirms this irreversible operation — the CLI never prompts.

Exemplos

# 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

Formato dos dados (--output json)

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

As operações list retornam { "items": [...] } e, quando o backend sinaliza mais páginas por meio de cabeçalhos Elements-Has-More / Elements-Next-Page-Token , inclui um objeto Pagination com HasMore e NextPageToken.

As chamadas com falha aparecem com Failure, o status HTTP como Message e o corpo do servidor como Instructions.

Relacionado

• uip is connections — --connection-id os valores vêm de connections list / connections create.
• uip is connectors — descubra a chave do conector primeiro.
• uip is activities — consulte as operações nomeadas que um conector expõe.
• uip is triggers — equivalentes orientados a eventos para os verbos do plano de dados aqui.

Veja também

• Visão geral da ferramenta do Integration Service
• Opções globais
• Códigos de saída