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.

agendamento de avaliação da uip

Sintaxe e opções para "uip eval Schedule", que cria, lista, atualiza, pausa, retoma e exclui agendamentos de avaliação recorrentes para um processo do Orchestrator.

uip eval schedule gerencia execuções de avaliação recorrentes para um processo do Orchestrator: crie um agendamento acionado por cron que executa um determinado conjunto de avaliação em um temporizador e, em seguida, liste, inspecione, atualize, pause, retome ou exclua-o. Essa é a contraparte programada para uma execução única — consulte uip eval para obter a visão geral de todo o subsistema eval , incluindo execute-and-evaluate (execução uma vez, de forma síncrona) e run (inspecionar execuções anteriores). Para o que um conjunto de avaliação realmente contém, consulte uip eval eval-set.

Cada agendamento pertence a um processo--process-key () e executa um conjunto de avaliação--eval-set-id () em uma expressão CRON UTC de cinco campos.

Resumo​

uip eval schedule create  --process-key <guid> --eval-set-id <guid> --cron <expr> [--workload-id <guid>] [--folder-key <guid>] [--tenant <tenant>]
uip eval schedule list    --process-key <guid> [--tenant <tenant>]
uip eval schedule get     <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule update  <schedule-id> --process-key <guid> [--eval-set-id <guid>] [--cron <expr>] [--tenant <tenant>]
uip eval schedule pause   <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule resume  <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule delete  <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule create  --process-key <guid> --eval-set-id <guid> --cron <expr> [--workload-id <guid>] [--folder-key <guid>] [--tenant <tenant>]
uip eval schedule list    --process-key <guid> [--tenant <tenant>]
uip eval schedule get     <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule update  <schedule-id> --process-key <guid> [--eval-set-id <guid>] [--cron <expr>] [--tenant <tenant>]
uip eval schedule pause   <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule resume  <schedule-id> --process-key <guid> [--tenant <tenant>]
uip eval schedule delete  <schedule-id> --process-key <guid> [--tenant <tenant>]

Verbo​

TextoFinalidade
createCrie um novo agendamento recorrente para um processo.
listLista cada agendamento de um processo.
getBusca um agendamento por ID.
updateAlterar o conjunto de avaliação e/ou a expressão CRON de um agendamento.
pausePausar um agendamento ativo.
resumeRetomar um agendamento pausado.
deleteExclua um agendamento.

criação do agendamento de avaliação da uip​

Crie um agendamento que execute um conjunto de avaliação em um gatilho cron UTC recorrente.

Se --workload-id ou --folder-key forem omitidos, o comando procurará o conjunto de avaliação primeiro (GET .../evalSets/<eval-set-id>) e preencherá ambos a partir dele — você só precisa passá-los explicitamente para substituir essa resolução.

Opções​

ShortLongValorPadrãoDescription
—--process-keyGUID—Obrigatório. Chave de processo (GUD de implantação) — identifica a versão do Orchestrator.
—--workload-idGUIDresolvido do conjunto de avaliaçãoID da carga de trabalho.
—--eval-set-idGUID—Obrigatório. Avaliação definida para ser executada em cada gatilho.
—--cronExpressão Cron—Obrigatório. Expressão CRON de cinco campos, avaliada em UTC (por exemplo, "0 9 * * *" diariamente às 9h UTC).
—--folder-keyGUIDresolvido do conjunto de avaliaçãoChave da pasta do Orchestrator.
—--tenantnamepadrão da sessãoNome do tenant da UiPath. Opção simples, não obsoleta.

Exemplos​

# Daily at 9 AM UTC
uip eval schedule create --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 \
  --eval-set-id f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04 --cron "0 9 * * *"
# Daily at 9 AM UTC
uip eval schedule create --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 \
  --eval-set-id f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04 --cron "0 9 * * *"

Formato dos dados (--output json)​

{
  "Code": "EvalScheduleCreated",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}
{
  "Code": "EvalScheduleCreated",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

UpdatedAt está presente apenas quando um agendamento foi alterado pelo menos uma vez (ausente em uma nova resposta create).

lista de agendamentos de avaliação da uip​

Lista cada agendamento registrado para um processo.

Opções​

ShortLongValorPadrãoDescription
—--process-keyGUID—Obrigatório. Chave do processo.
—--tenantnamepadrão da sessãoNome do tenant da UiPath.

Exemplos​

uip eval schedule list --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09
uip eval schedule list --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

Formato dos dados (--output json)​

{
  "Code": "EvalScheduleList",
  "Data": [
    {
      "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
      "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
      "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
      "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
      "CronExpression": "0 9 * * *",
      "Status": "active",
      "CreatedAt": "2025-04-15T10:29:55Z"
    }
  ]
}
{
  "Code": "EvalScheduleList",
  "Data": [
    {
      "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
      "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
      "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
      "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
      "CronExpression": "0 9 * * *",
      "Status": "active",
      "CreatedAt": "2025-04-15T10:29:55Z"
    }
  ]
}

agendamento de avaliação do uip obter​

Busca um agendamento por ID.

Argumentos​

NameRequiredFinalidade
<schedule-id>simAgende o GUID, de create ou list.

Opções​

ShortLongValorPadrãoDescription
—--process-keyGUID—Obrigatório. Chave do processo.
—--tenantnamepadrão da sessãoNome do tenant da UiPath.

Exemplos​

uip eval schedule get b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09
uip eval schedule get b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

Formato dos dados (--output json)​

{
  "Code": "EvalScheduleDetails",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}
{
  "Code": "EvalScheduleDetails",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

atualização do agendamento da avaliação da uip​

Alterar o conjunto de avaliação e/ou a expressão CRON de um agendamento. Pelo menos um dos --eval-set-id/--cron é necessário — passar nenhum dos dois falha no lado do cliente antes de qualquer chamada de rede.

Argumentos​

NameRequiredFinalidade
<schedule-id>simAgende para atualizar.

Opções​

ShortLongValorPadrãoDescription
—--process-keyGUID—Obrigatório. Chave do processo.
—--eval-set-idGUID—Novo conjunto de avaliação. Pelo menos um isto ou --cron é necessário.
—--cronExpressão Cron—Nova expressão cron de cinco campos, UTC. Pelo menos um isto ou --eval-set-id é necessário.
—--tenantnamepadrão da sessãoNome do tenant da UiPath.

Exemplos​

uip eval schedule update b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --cron "0 */6 * * *"
uip eval schedule update b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --cron "0 */6 * * *"

Formato dos dados (--output json)​

{
  "Code": "EvalScheduleUpdated",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 */6 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z",
    "UpdatedAt": "2025-04-16T08:00:00Z"
  }
}
{
  "Code": "EvalScheduleUpdated",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 */6 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z",
    "UpdatedAt": "2025-04-16T08:00:00Z"
  }
}

A omissão de --eval-set-id e --cron falha com:

{
  "Result": "Failure",
  "Message": "At least one of --eval-set-id or --cron must be provided.",
  "Instructions": "Provide the field(s) you want to update."
}
{
  "Result": "Failure",
  "Message": "At least one of --eval-set-id or --cron must be provided.",
  "Instructions": "Provide the field(s) you want to update."
}

pausa no agendamento da avaliação da uip​

Pausar um agendamento ativo — nenhuma execução adicional será disparada até resume.

Argumentos​

NameRequiredFinalidade
<schedule-id>simAgende para pausar.

Opções​

ShortLongValorPadrãoDescription
—--process-keyGUID—Obrigatório. Chave do processo.
—--tenantnamepadrão da sessãoNome do tenant da UiPath.

Exemplos​

uip eval schedule pause b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09
uip eval schedule pause b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

Formato dos dados (--output json)​

{
  "Code": "EvalSchedulePaused",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "paused",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}
{
  "Code": "EvalSchedulePaused",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "paused",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

Retomar ao agendamento da avaliação da uip​

Retomar um agendamento pausado.

Argumentos​

NameRequiredFinalidade
<schedule-id>simAgende para retomar.

Opções​

ShortLongValorPadrãoDescription
—--process-keyGUID—Obrigatório. Chave do processo.
—--tenantnamepadrão da sessãoNome do tenant da UiPath.

Exemplos​

uip eval schedule resume b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09
uip eval schedule resume b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

Formato dos dados (--output json)​

{
  "Code": "EvalScheduleResumed",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}
{
  "Code": "EvalScheduleResumed",
  "Data": {
    "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001",
    "WorkloadId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProcessKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09",
    "FolderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e",
    "EvalSetId": "f3a7d219-8b4c-4e62-a951-7d3f6e2c8b04",
    "CronExpression": "0 9 * * *",
    "Status": "active",
    "CreatedAt": "2025-04-15T10:29:55Z"
  }
}

exclusão do agendamento de avaliação do uip​

Exclui um agendamento permanentemente.

Argumentos​

NameRequiredFinalidade
<schedule-id>simAgende para excluir.

Opções​

ShortLongValorPadrãoDescription
—--process-keyGUID—Obrigatório. Chave do processo.
—--tenantnamepadrão da sessãoNome do tenant da UiPath.

Exemplos​

uip eval schedule delete b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09
uip eval schedule delete b2c3d4e5-0000-0000-0000-000000000001 \
  --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09

Formato dos dados (--output json)​

{
  "Code": "EvalScheduleDeleted",
  "Data": { "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001" }
}
{
  "Code": "EvalScheduleDeleted",
  "Data": { "ScheduleId": "b2c3d4e5-0000-0000-0000-000000000001" }
}

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