UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

uip é gatilhos

Sintaxe e opções para "uip is triggers", que lê os metadados de gancho de evento para atividades de disparo do conector.

uip is triggers a visualização somente leitura dos ganchos de evento de um conector — os metadados que suportam as atividades do gatilho. Um gatilho é disparado quando um objeto de conector é CREATED, UPDATED ou DELETED. objects lista os objetos que são compatíveis com uma operação de gatilho; describe retorna os metadados completos do gatilho (modo do evento, parâmetros, campos de filtro, campos de saída) para um objeto. Ambos os verbos armazenam resultados em cache; --connection-id é opcional, mas recomendado — sem ele, objetos/campos personalizados podem estar faltando e a resposta carrega um Warning.

Resumo​

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

Verbo​

TextoFinalidade
objectsListe objetos compatíveis com uma operação de gatilho em um conector.
describeObtenha metadados de gatilho completos para um objeto em uma operação.

uipath dispara objetos​

Liste objetos compatíveis com uma determinada operação de gatilho em um conector. Os resultados em cache são gravados apenas quando --connection-id é fornecido.

Argumentos​

NameRequiredFinalidade
<connector-key>simChave de conector, por exemplo uipath-zoho-desk
<operation>simOperação de disparo: CREATED, UPDATED ou DELETED (sem diferença entre maiúsculas e minúsculas; normalizado para maiúsculas).

Opções​

ShortLongValorPadrãoDescription
—--connection-idid—Escopo para uma conexão (habilita objetos personalizados).
—--refreshBandeiradesativadaForça a nova busca da API, ignorando o cache.

Exemplos​

uip is triggers objects uipath-zoho-desk CREATED

# Connection-scoped — includes custom objects
uip is triggers objects uipath-zoho-desk UPDATED \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

uip is triggers objects uipath-zoho-desk DELETED \
    --output-filter 'Data[].{name:name, display:displayName}'
uip is triggers objects uipath-zoho-desk CREATED

# Connection-scoped — includes custom objects
uip is triggers objects uipath-zoho-desk UPDATED \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

uip is triggers objects uipath-zoho-desk DELETED \
    --output-filter 'Data[].{name:name, display:displayName}'

Formato dos dados (--output json)​

{
  "Code": "TriggerObjectList",
  "Data": [
    {
      "hideEventIDField": false,
      "debugDisabled": false,
      "displayName": "Tickets",
      "name": "tickets",
      "isHidden": false,
      "supportedAuths": [],
      "isWebhookUrlVisible": false,
      "byoaConnection": false,
      "hasStaticLeftOperandFilterBuilder": false
    }
  ]
}
{
  "Code": "TriggerObjectList",
  "Data": [
    {
      "hideEventIDField": false,
      "debugDisabled": false,
      "displayName": "Tickets",
      "name": "tickets",
      "isHidden": false,
      "supportedAuths": [],
      "isWebhookUrlVisible": false,
      "byoaConnection": false,
      "hasStaticLeftOperandFilterBuilder": false
    }
  ]
}

Sem --connection-id, a resposta carrega um Warning indicando que os objetos personalizados podem estar ausentes.

uip é a descrição dos gatilhos​

Retorne metadados de gatilho completos para um objeto em uma operação de gatilho: modo de evento (sondagem versus webhook), parâmetros de evento, campos de filtro e campos de saída.

Argumentos​

NameRequiredFinalidade
<connector-key>simChave do conector.
<operation>simOperação de disparo (CREATED, UPDATED, DELETED).
<object-name>simNome do objeto (por exemplo, tickets). Encontre-o com triggers objects.

Opções​

ShortLongValorPadrãoDescription
—--connection-idid—Escopo para uma conexão (habilita campos personalizados).
—--refreshBandeiradesativadaForça a nova busca da API, ignorando o cache.

Exemplos​

uip is triggers describe uipath-zoho-desk CREATED tickets

uip is triggers describe uipath-zoho-desk CREATED tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

uip is triggers describe uipath-zoho-desk UPDATED tickets \
    --output-filter 'Data.outputFields[].name'
uip is triggers describe uipath-zoho-desk CREATED tickets

uip is triggers describe uipath-zoho-desk CREATED tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

uip is triggers describe uipath-zoho-desk UPDATED tickets \
    --output-filter 'Data.outputFields[].name'

Formato dos dados (--output json)​

{
  "Code": "TriggerMetadata",
  "Data": {
    "name": "tickets",
    "displayName": "Tickets",
    "elementKey": "uipath-zoho-desk",
    "operation": "CREATED",
    "eventMode": "polling",
    "byoaConnection": false,
    "isWebhookUrlVisible": false,
    "eventParameters": [],
    "filterFields": [
      { "name": "subject", "type": "string", "displayName": "Subject", "description": "The Subject" }
    ],
    "outputFields": [
      { "name": "id", "type": "string", "displayName": "ID", "description": "The ID" },
      { "name": "subject", "type": "string", "displayName": "Subject", "description": "The Subject" }
    ]
  }
}
{
  "Code": "TriggerMetadata",
  "Data": {
    "name": "tickets",
    "displayName": "Tickets",
    "elementKey": "uipath-zoho-desk",
    "operation": "CREATED",
    "eventMode": "polling",
    "byoaConnection": false,
    "isWebhookUrlVisible": false,
    "eventParameters": [],
    "filterFields": [
      { "name": "subject", "type": "string", "displayName": "Subject", "description": "The Subject" }
    ],
    "outputFields": [
      { "name": "id", "type": "string", "displayName": "ID", "description": "The ID" },
      { "name": "subject", "type": "string", "displayName": "Subject", "description": "The Subject" }
    ]
  }
}

Para operações no estilo de CRUD, a resposta também revela um Hint sugerindo o comando próximo triggers objects . Sem --connection-id, a resposta carrega um Warning sobre campos personalizados ausentes.

  • uip is activities — passe --triggers para listar apenas atividades de gatilho.
  • uip is connectors — connectors get relata HasEvents: "Yes" para conectores que expõem gatilhos.
  • uip is connections — forneça --connection-id de uma conexão aqui para metadados com reconhecimento personalizado.
  • uip is resources — recurso irmãos para o lado do plano de dados (CRUD) do mesmo conector.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades