uip é recursos

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 execute chama o plano de dados do conector (Criar / Listar / Obter / Atualizar / Substituir / Excluir) contra uma conexão. Cada verbo execute requer --connection-id; as leituras de metadados em cache (list, describe) aceitam-no opcionalmente para exibir objetos/campos personalizados.

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.
execute	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).
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--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 (por exemplo, tickets). Encontrar nomes com resources list.

Opções

Short	Long	Valor	Padrão	Description
—	--connection-id	id	—	Escopo para uma conexão (habilita campos personalizados).
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--operation	ENUM	—	List, Retrieve, Create, Update, Delete, ou Replace.
—	--refresh	Bandeira	desativada	Força a nova busca da API, ignorando o cache.

Exemplos

# List operations available on this object
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'

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.

uipath é execução de recursos

Chame o plano de dados do conector. execute si é um grupo; os verbos reais são create, list, get, update, replace e delete. Cada verbo requer --connection-id; create, update e replace também exigem --body com um corpo de solicitação JSON.

uip is resources execute create   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute list     <connector-key> <object-name> --connection-id <id>
uip is resources execute get      <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources execute update   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute replace  <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources execute delete   <connector-key> <object-name> --connection-id <id> [--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.
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--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.

Exemplos

# Create a ticket
uip is resources execute 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 execute list uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

# Delete a ticket by ID
uip is resources execute delete uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --query 'id=TK-1001'

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