UiPath Documentation
uipath-cli
latest
false
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.

Guia do usuário da UiPath CLI

processo do uip Maestro e processos do uip Maestro

Depois que um pacote Maestro é publicado no Orchestrator, ele se torna um processo do tipo ProcessOrchestration. Esta página abrange dois grupos de comando relacionados:

  • uip maestro process operações por pasta em uma única definição de processo (listar em uma pasta, obter seu esquema, executá-la).
  • uip maestro processes plral) — resumos de todo o tenant e pesquisa de incidentes por processo.

Resumo

# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro process run  <process-key> <folder-key>
                          [-i, --inputs <json>] [-t, --tenant <name>]
                          [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                          [--validate] [--login-validity <minutes>]

# Plural — tenant-wide summary and incident surface
uip maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]
# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro process run  <process-key> <folder-key>
                          [-i, --inputs <json>] [-t, --tenant <name>]
                          [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                          [--validate] [--login-validity <minutes>]

# Plural — tenant-wide summary and incident surface
uip maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]

Todos os subcomandos exigem uip login e honram as opções globais. Os códigos de saída seguem o contrato padrão.


lista de processos do uip Maestro

Liste os processos (versões) do Maestro disponíveis em uma pasta específica.

Opções

OpçãoRequiredDescription
-f, --folder-key <key>simChave da pasta (GUID).
-t, --tenant <name>nãoNome do tenant. O padrão para o tenant autenticado.
--filter <odata>nãoFiltro OData adicional aplicado no lado do servidor.
--login-validity <minutes>nãoLimite de atualização do token (padrão 10).

Data shape (--output json)

{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":       "InvoiceOrchestration",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "active":     "Yes",
      "latest":     "Yes"
    }
  ]
}
{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":       "InvoiceOrchestration",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "active":     "Yes",
      "latest":     "Yes"
    }
  ]
}

processo do uip Maestro obter

Buscar o esquema de entry-point (esquemas JSON de entrada/saída) para um processo do Maestro.

Argumentos

  • <process-key> necessário) — chave de processo.
  • <feed-id> (necessário) — ID do feed (de list).

Opções

  • -f, --folder-key <key> (necessário)
  • -t, --tenant
  • --login-validity

Formato dos dados

{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}
{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema e OutputSchema são strings de Esquema JSON redefinidas.


execução de processo do uip Maestro

Inicie um trabalho do Maestro para um processo publicado.

Argumentos

  • <process-key> necessário) — chave de processo.
  • <folder-key> necessário) — chave de pasta (GUID).

Opções

OpçãoDescription
-i, --inputs <json>Entradas como uma string JSON ou @path/to/file.json. Se omitido e stdin estiver tabulado, stdin será analisado.
-t, --tenant <name>Nome do tenant (o padrão é tenant autenticado).
--release-key <key>Chave de lançamento (GUID) — de process list.
--feed-id <id>ID do feed para pesquisa de pacote (opcional).
--robot-ids <ids>IDs de robô separados por vírgulas (inteiros). Os valores inválidos falham rapidamente.
--validateValide entradas em relação ao esquema do processo antes de executar. Apenas verificações básicas — campos obrigatórios + tipos primitivos.
--login-validity <minutes>Limite de atualização do token (padrão 10).

Precedência de entrada: --inputs <json> / --inputs @file.json > stdin > empty object {}.

Exemplos

# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}'

# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"

# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}' --validate
# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}'

# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"

# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}' --validate

Formato dos dados

{
  "Code": "MaestroJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}
{
  "Code": "MaestroJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}

Próxima etapa: para transmitir uip maestro job status <jobKey> uip maestro job traces <jobKey> pesquisar.


lista de processos do uip Maestro

Resumo em todo o tenant dos processos do Maestro (sem filtro processType aplicado nesta camada — o comando múltiplos é compartilhado entre ferramentas e não abrange o lado do servidor ProcessOrchestration ).

Argumentos

Nenhum.

Formato dos dados

{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
Observação:

O conjunto de campos exato de cada resumo de processo é especificado pelo runtime do Maestro e pode evoluir; execute o comando uma vez com --output json em um tenant com dados para ver os campos que você consumirá e fixe @uipath/cli no CI se você analisar campos específicos.


incidentes de processos do uip Maestro

Obtenha todos os incidentes para uma definição de processo específica do Maestro.

Argumentos

  • <process-key> necessário) — chave de definição de processo.

Opções

  • --folder-key <key> opcional) — chave de pasta para delimitar a pesquisa.

Formato dos dados

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}
{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

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