uip é recursos

Sintaxe e opções para "uip is resource", que lista, descreve e executa operações em objetos do plano de dados do conector.

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:

O grupo de verbos do plano de dados é uip is resources run, não execute — uip is resources execute ... não existe e falha com "comando desconhecido".

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	Nome do objeto — o objectName da configuração JSON da atividade (por exemplo, tickets). Encontrar nomes com resources list. Aborda o objeto da mesma maneira sob ambos os valores --activity-version (veja abaixo).

Opções

Short	Long	Valor	Padrão	Description
—	--connection-id	id	—	Escopo para uma conexão (habilita campos personalizados; necessário junto com --field).
—	--operation	ENUM	—	List, Retrieve, Create, Update, Delete ou Replace. Necessário junto com --field.
—	--activity-version	1.0.0 | 4.0.0	1.0.0	Quais pontos de extremidade de metadados de atividade consultar — consulte Versões de metadados de atividade abaixo.
-f	--field	name=value	—	Valor do campo pai. Repetível. Executa a ObjectAction do tipo de API do conector (por exemplo, a GenerateSchema do Jira, a GenerateQuerySchema do Salesforce) e mescla sua resposta de campo personalizado em requestFields. Requer --connection-id e --operation. Não compatível com --activity-version 4.0.0.
—	--action	name	inferido	Nome explícito do ObjectAction tipo da API (por GenerateSchema exemplo,). Opcional — inferido dos nomes --field quando omitido; use-a para desambiguar quando mais de uma ação puder corresponder.
—	--refresh	Bandeira	desativada	Força a nova busca da API, ignorando o cache. O cache também é ignorado automaticamente sempre que --field é fornecido, pois uma resposta de ação de design varia de acordo com a combinação de campo pai.

Versões de metadados de atividade

--activity-version alterna qual o endpoint de metadados do Integration Service describe consulta:

• 1.0.0 padrão) — pontos de extremidade de elementos v3, com escopo de conexão. Suporta -f/--field pesquisas de ação de design.
• 4.0.0 — pontos de extremidade de elementos v4, não com escopo de conexão. Passar --connection-id ao lado dele é aceito, mas ignorado (com um aviso), pois a v4 não precisa dele para a própria busca. -f/--field é rejeitado totalmente com --activity-version 4.0.0 — ObjectActions de tempo de design são uma funcionalidade somente v3 com escopo de instância.

Em ambos os casos, a <object-name> posição significa a mesma coisa — o nome do objeto — portanto, não há diferença de endereçamento entre as duas versões, apenas qual ponto de extremidade de back-end responde à chamada.

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:

Se uma chamada -f/--field voltar contendo apenas os campos que você forneceu (nenhum dos campos personalizados da própria conexão), a resposta também carregará um Warning: um dos valores que você passou provavelmente não existe nessa conexão. Compare-o com a pesquisa para esse campo.

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.

Com -f/--field (campo pai / pesquisa de ação de design), requestFields reflete o esquema específico da conexão mesclado:

{
  "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 é execução de recursos

Chame o plano de dados do conector. run em si é um grupo; os verbos reais são,,,,create listgetupdatereplace deletee. Cada verbo requer --connection-id; create, update e replace também exigem --body com um corpo de solicitação JSON. delete é destrutivo e requer -y, --yes — a CLI nunca solicita.

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	—	Necessário delete em. Confirma esta operação irreversível — a CLI nunca solicita.

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