uip ou trabalhos

Sintaxe e opções para "uip or jobs", que inicia, interrompe, reinicia e inspeciona as execuções de processos do Orchestrator e seus logs.

uip or jobs gerencia execuções de processos: inicia trabalhos a partir de processos, para e reinicia-os, retoma trabalhos suspensos e inspeciona logs, traces, dados do Healing Agent e histórico de estado. Cada trabalho é identificado por uma chave GUID que é globalmente exclusiva — a maioria dos verbos resolve a pasta da chave automaticamente.

Resumo

uip or jobs <verb> [options]

Verbo

Texto	Finalidade
list	Listar trabalhos, opcionalmente com escopo de uma pasta e filtrados por estado, processo, origem ou intervalo de tempo.
get	Busca um trabalho por chave, incluindo argumentos de entrada/saída e (para trabalhos Pendentes) motivos de diagnóstico.
start	Iniciar um ou mais trabalhos para um processo; opcionalmente, aguarde a conclusão e baixe a saída.
stop	Faça uma interrupção suave ou forcie o encerramento de um ou mais trabalhos em execução/pendentes.
restart	Crie um novo trabalho a partir de um trabalho com falha ou interrompido.
resume	Retome um trabalho suspenso, opcionalmente com argumentos de entrada atualizados.
logs	Buscar logs de execução do robô para um trabalho; filtre por nível ou exporte para CSV.
traces	Buscar rastreamentos de execução de LLMOps para um trabalho com agente (tipo Agente).
healing-data	Baixe os dados de recuperação do Healing Agent (capturas de tela, dados de interface gráfica, logs) como um ZIP.
history	Mostra as transições de estado de um trabalho.

uip ou lista de trabalhos

Liste os trabalhos em uma pasta ou em cada pasta acessível com --all-folders. Retorna chave do trabalho, estado, nome do processo, tempo e informações da máquina. Exatamente um de um seletor de pasta (--folder-path/--folder-key) ou --all-folders é necessário — o comando se recusa a ser executado com ambos ou com nenhum.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Escopo para uma pasta por caminho (por exemplo, Shared). Forneça este, --folder-key, ou --all-folders.
—	--folder-key	GUID	—	Escopo para uma pasta por chave.
—	--all-folders	Bandeira	desativada	Liste os trabalhos em todas as pastas acessíveis. Exclusivo mutuamente com os seletores de pasta.
—	--state	ENUM	—	Pending, Running, Successful, Faulted, Stopped, Stopping, Suspended, Resumed, Terminating.
—	--process-name	text	—	Contains-match no nome do processo (versão).
—	--source	ENUM	—	Filtra por tipo de origem de trabalho (por exemplo, Manual, Schedule, Queue, Agent).
—	--created-after	ISO 8601	—	Trabalhos criados nesta data/hora ou após esta data/hora.
—	--created-before	ISO 8601	—	Trabalhos criados estritamente antes dessa data/hora.
—	--started-after	ISO 8601	—	Os trabalhos começaram nessa data/hora.
—	--started-before	ISO 8601	—	Os trabalhos começaram estritamente antes dessa data/hora.
—	--ended-after	ISO 8601	—	Os trabalhos terminaram nessa data/hora.
—	--ended-before	ISO 8601	—	Os trabalhos terminaram estritamente antes dessa data/hora.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--sort-by	Campo	Id desc	Expressão de classificação do OData.
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa em vez do resumo selecionado.

Exemplos

# The 50 most recent jobs across every accessible folder
uip or jobs list --all-folders

# Running jobs in a specific folder, newest first
uip or jobs list --folder-path "Shared" --state Running

# Pull only job keys and states, script-friendly
uip or jobs list --all-folders --state Faulted --limit 200 \
    --output-filter 'Data[].{key:Key, state:State}'

Formato dos dados (--output json)

{
  "Code": "JobList",
  "Data": [
    {
      "Key": "b2c3d4e5-0000-0000-0000-000000000001",
      "State": "Running",
      "ProcessName": "InvoiceProcessing",
      "ReleaseKey": "c3d4e5f6-0000-0000-0000-000000000001",
      "Source": "Manual",
      "Type": "Unattended",
      "Priority": "Normal",
      "Machine": "prod-worker-01",
      "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
      "StartTime": "2025-04-15T10:30:00Z",
      "EndTime": "",
      "CreationTime": "2025-04-15T10:29:55Z"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

uip ou trabalhos obter

Busca um trabalho por chave GUID. Retorna o estado, argumentos de entrada/saída, tempo, informações da máquina e detalhes de erro se houver falha. Se o estado do trabalho for Pending, a saída também incluirá PendingReasons (o relatório de diagnóstico da API sobre por que o trabalho não foi iniciado — disponibilidade de robôs, capacidade etc.). Nenhum contexto de pasta é necessário.

Se o trabalho tiver um OutputFile, ele será baixado automaticamente para o diretório atual (ou --output-dir) como output-<job-key>.dat. Transmita --no-download para ignorar.

Argumentos

Name	Required	Finalidade
<job-key>	sim	Chave do trabalho (GUID). Encontre-o com uip or jobs list.

Opções

Short	Long	Valor	Padrão	Description
—	--output-dir	Path	diretório atual	Diretório para o OutputFile baixado.
—	--no-download	Bandeira	desativada	Ignorar download OutputFile .
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa.

Exemplos

uip or jobs get b2c3d4e5-0000-0000-0000-000000000001

# Skip the output-file download (useful in read-only containers)
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 --no-download

# Extract just output arguments
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.OutputArguments'

Formato dos dados (--output json)

{
  "Code": "JobGet",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Successful",
    "ReleaseName": "InvoiceProcessing",
    "StartTime": "2025-04-15T10:30:00Z",
    "EndTime": "2025-04-15T10:32:11Z",
    "InputArguments": "{\"invoicePath\":\"/data/inv.pdf\"}",
    "OutputArguments": "{\"result\":\"Processed\"}",
    "HostMachineName": "prod-worker-01",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

uip ou início dos trabalhos

Inicie um ou mais trabalhos para um processo. O <process-key> é o GUID retornado por uip or processes list (não packages list). A pasta é opcional — se nem --folder-path nem --folder-key for fornecido, ela será inferida do processo.

uip or packages entry-points para ver esquemas de argumentos de entrada/saída para uma versão do pacote antes de iniciar.

Argumentos

Name	Required	Finalidade
<process-key>	sim	Chave de processo (lançamento) (GUID) de uip or processes list.

Opções

Identidade e tenant

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	inferido	Caminho da pasta; inferido do processo se omitido.
—	--folder-key	GUID	inferido	Chave da pasta; inferido do processo se omitido.

Estratégia de execução

Short	Long	Valor	Padrão	Description
—	--strategy	ENUM	ModernJobsCount	ModernJobsCount, All, Specific, JobsCount.
—	--jobs-count	Número	1	Quantos trabalhos criar (para estratégias baseadas em contagem).
—	--runtime-type	ENUM	pasta configuração	Unattended, Headless, Serverless, NonProduction, Development, TestAutomation.
—	--job-priority	ENUM	—	Low, Normal, High.
—	--reference	text	—	String de referência de forma livre armazenada no trabalho.
—	--run-as-me	Bandeira	desativada	Executar com a identidade do chamador.
—	--healing-agent	Bandeira	desativada	Habilite o Healing Agent (Autopilot para Robots) para esta execução, para se recuperar de falhas de seletor e erros de runtime semelhantes. O Autopilot no nível do tenant já deve estar habilitado.
—	--user-keys	CSV	—	GUIDs do usuário para executar (resolvido para robôs não assistidos).
—	--machine-keys	CSV	—	Machine GUIDs para o destino.

Entrada e anexos

Short	Long	Valor	Padrão	Description
—	--input-arguments	JSON	—	Carga do JSON embutida. Descarrega automaticamente para InputFile acima de 10 mil caracteres. Mutualmente exclusivo com --input-file.
—	--input-file	Path	—	Carregue um arquivo como o InputFile do trabalho. Mutualmente exclusivo com --input-arguments.
—	--attachment	[name=]path	—	Carregue um arquivo e anexe-o. Repetível. --attachment ./doc.pdf nomes automáticos a partir do nome do arquivo; --attachment invoice=./report.pdf define um nome explícito.
—	--attachment-id	GUID	—	Anexe um anexo existente por ID. Repetível. Encontrar IDs com attachments list --job-key.
—	--environment-variables	text	—	Variáveis de ambiente como pares KEY=VALUE separados por nova linha (não JSON). Validado antes do envio.

Aguardando a conclusão

Short	Long	Valor	Padrão	Description
—	--wait-for-completion	Bandeira	desativada	Pesquise até que o trabalho atinja Successful, Faulted ou Stopped.
—	--timeout	segundos	300	Tempo de espera máximo (requer --wait-for-completion).
—	--poll-interval	segundos	5	Intervalo de pesquisa (requer --wait-for-completion).
—	--output-dir	Path	diretório atual	Onde salvar OutputFile (requer --wait-for-completion).
—	--no-download	Bandeira	desativada	Ignorar download de OutputFile (requer --wait-for-completion).

Observação:

--user-keys cada GUID de usuário para seu robô não assistido na pasta de destino. Os tipos de robô Attended e AttendedStudioWeb são filtrados — os trabalhos iniciados por CLI precisam de robôs unattended. Se não existir nenhum robô unattended para os usuários nessa pasta, o comando falhará.

Exemplos

# Minimal — start one job for a process
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001

# Start with input arguments and wait for completion
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-arguments '{"invoicePath":"/data/inv.pdf"}' \
    --wait-for-completion --timeout 600

# Upload a file as input and attach a supporting document
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-file ./payload.json \
    --attachment invoice=./report.pdf

Formato dos dados (--output json)

Sem --wait-for-completion:

{
  "Code": "JobStarted",
  "Data": {
    "Jobs": [
      {
        "Key": "b2c3d4e5-0000-0000-0000-000000000099",
        "State": "Pending",
        "ProcessName": "InvoiceProcessing",
        "Source": "Manual",
        "Type": "Unattended",
        "Priority": "Normal",
        "Machine": "",
        "StartTime": "",
        "EndTime": "",
        "CreationTime": "2025-04-15T10:29:55Z"
      }
    ]
  }
}

Com --wait-for-completion, o Code é JobCompleted (ou JobFaulted em caso de falha) e Data tem o mesmo formato que jobs get mais um campo Duration . Se o trabalho falhar, o processo sairá com o código 1.

Substituições de código de saída específicos do verbo

• --wait-for-completion + trabalho termina em Faulted: sai 1 mesmo que o comando tenha sucesso em observar o resultado.
• --wait-for-completion + tempo limite atingido: sai de 1 com a chave do trabalho atual em Instructions para que você possa pesquisar com jobs get.

uip ou interrupção dos trabalhos

Interrompa um ou mais trabalhos em execução ou pendentes. Com uma única chave, respeita --strategy (SoftStop ou Kill). Com várias chaves, sempre forçar interrupções (encerrar) por meio da API em massa — --strategy é ignorado nesse caso. Nenhum contexto de pasta é necessário; resolvidos a partir da primeira chave do trabalho.

Argumentos

Name	Required	Finalidade
<job-keys...>	sim	Uma ou mais chaves de trabalho (GUIDs).

Opções

Short	Long	Valor	Padrão	Description
—	--strategy	ENUM	SoftStop	SoftStop ( gracioso) ou Kill (imediato). Aplica-se apenas a interrupções com uma única tecla.

Exemplos

uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001
uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001 --strategy Kill
uip or jobs stop key-1 key-2 key-3   # bulk force-stop

Formato dos dados (--output json)

Chave única:

{
  "Code": "JobStopped",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "Strategy": "SoftStop",
    "Status": "Stop requested"
  }
}

Várias chaves retornam Code: "JobsStopped" com JobKeys, Strategy: "Kill (force stop)" e uma string Status .

reinicialização da uip ou dos trabalhos

Crie um novo trabalho a partir de um trabalho com falha ou interrompido. A pasta é resolvida a partir da chave do trabalho.

Argumentos

Name	Required	Finalidade
<job-key>	sim	Chave do trabalho (GUID) para reiniciar.

Opções

Short	Long	Valor	Padrão	Description

Exemplos

uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001
uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001 --output-filter 'Data.Key'

Formato dos dados (--output json)

{
  "Code": "JobRestarted",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000050",
    "State": "Pending",
    "ProcessName": "InvoiceProcessing",
    "Status": "Restart requested"
  }
}

uip ou retomada dos trabalhos

Retome um trabalho suspenso. Os trabalhos ficam suspensos quando usam a atividade Suspend em um fluxo de trabalho de longa duração. Opcionalmente, transmita o novo --input-arguments para continuar com os dados atualizados.

Argumentos

Name	Required	Finalidade
<job-key>	sim	Chave do trabalho (GUID) para retomar.

Opções

Short	Long	Valor	Padrão	Description
—	--input-arguments	JSON	—	Argumentos de entrada de substituição.

Exemplos

uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001
uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001 \
    --input-arguments '{"approved":true}'

Formato dos dados (--output json)

{
  "Code": "JobResumed",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Resumed",
    "ProcessName": "ApprovalFlow",
    "Status": "Resume requested"
  }
}

logs de uip ou de trabalhos

Busca os logs de execução do robô para um trabalho. Os logs são retornados mais recente primeiro. --level para filtrar por gravidade. Com --export, os logs são exportados do lado do servidor para CSV e baixados quando estiverem prontos.

Argumentos

Name	Required	Finalidade
<job-key>	sim	Chave do trabalho (GUID). Validado como um UUID antes de qualquer chamada de API.

Opções

Short	Long	Valor	Padrão	Description
—	--level	ENUM	—	Fatal, Error, Warning, Info, Trace.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--export	Bandeira	desativada	Exporte para CSV por meio da API de exportação no lado do servidor.
-o	--output	Path	robot-logs-<job-key>.csv	Caminho do CSV de saída. Apenas com --export.

Exemplos

uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --level Error --limit 100
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --export -o ./run.csv
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 \
    --level Error --output-filter 'Data[].Message'

Formato dos dados (--output json)

Modo em linha:

{
  "Code": "JobLogs",
  "Data": [
    {
      "Level": "Error",
      "TimeStamp": "2025-04-15T10:31:02Z",
      "Message": "Selector not found: ctrl[name='submit']"
    }
  ]
}

--export emite Code: "JobLogsExported" com JobKey, FileName, Size e ExportId.

uip ou traces de trabalhos

Buscar traces de execução de LLMOps para um trabalho com agente — interações de LLM, chamadas de ferramentas e decisões de agente. Disponível apenas para processos do tipo Agente. A pasta é resolvida a partir da chave do trabalho.

Argumentos

Name	Required	Finalidade
<job-key>	sim	Chave do trabalho (GUID).

Opções

Short	Long	Valor	Padrão	Description

Exemplos

uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001
uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.messages'

Formato dos dados (--output json)

A carga útil de API bruta é passada inalterada em Data:

{
  "Code": "JobTraces",
  "Data": { "...": "raw LlmOps trace payload" }
}

uip ou trabalhos Healing-Data

Baixe os dados de recuperação do Healing Agent (Autopilot para Robots) como um ZIP: capturas de tela, dados do elemento de interface gráfica e logs de recuperação. Disponível apenas para trabalhos em que o Healing Agent estava ativo. O comando dispara uma exportação assíncrona, pesquisa a API de exportação até que ela seja finalizada e, em seguida, baixa o ZIP resultante.

Argumentos

Name	Required	Finalidade
<job-key>	sim	Chave do trabalho (GUID).

Opções

Short	Long	Valor	Padrão	Description
—	--directory-prefix	prefixo	—	Filtro de prefixo de caminho aplicado a arquivos exportados.
-o	--output	Path	healing-agent-data-<job-key>.zip	Caminho ZIP de saída.

Exemplos

uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    -o ./recovery.zip
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.FileName'

Formato dos dados (--output json)

{
  "Code": "JobHealingData",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "FileName": "healing-agent-data-b2c3d4e5-0000-0000-0000-000000000001.zip",
    "Size": 254318,
    "ExportId": 4711
  }
}

Observação:

A exportação no lado do servidor é consultada até 30 vezes em intervalos de 2 segundos (60 segundos no total). Se não for concluído nessa janela, o comando sai 1 com o ID de exportação para que você possa tentar novamente.

histórico de uip ou trabalhos

Buscar o histórico de transição de estado para um trabalho (Pending → Running → Successful/Faulted). A pasta é resolvida a partir da chave do trabalho.

Argumentos

Name	Required	Finalidade
<job-key>	sim	Chave do trabalho (GUID).

Opções

Short	Long	Valor	Padrão	Description

Exemplos

uip or jobs history b2c3d4e5-0000-0000-0000-000000000001
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data[].{state:State, ts:Timestamp}'
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 --output table

Formato dos dados (--output json)

{
  "Code": "JobHistory",
  "Data": [
    { "State": "Pending", "Timestamp": "2025-04-15T10:29:55Z", "JobId": 1001 },
    { "State": "Running", "Timestamp": "2025-04-15T10:30:00Z", "JobId": 1001 },
    { "State": "Successful", "Timestamp": "2025-04-15T10:32:11Z", "JobId": 1001 }
  ]
}

Códigos de saída

Consulte Códigos de saída para o contrato compartilhado. Substituições específicas de verbo:

• jobs start --wait-for-completion sai de 1 se o trabalho observado terminar Faulted ou se o tempo de espera esgotar.
• jobs healing-data sai de 1 se a exportação do lado do servidor não for concluída em cerca de 60 segundos.

Comandos relacionados

• uip or processes — gerencie as associações de processos (lançamento) que jobs start tem como alvo.
• uip or packages — especialmente packages entry-points para descobrir esquemas de argumentos de entrada/saída.
• uip or attachments — listar e baixar anexos do trabalho.
• uip or users — resolver nomes de usuário para chaves de --user-keys.
• uip or machines — resolver nomes de máquinas para chaves de --machine-keys.

Veja também

• Opções globais — --output, --output-filter, --log-level, --log-file.
• Sessões — como o contexto do tenant e da pasta são resolvidos.
• Seu primeiro pipeline — um guia passo a passo usando jobs start --wait-for-completion.