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

uip ou calendários

uip or calendars gerencia calendários — as listas com escopo de tenant de datas excluídas (também chamadas de "Dias não úteis") que gatilhos de tempo consultam para ignorar execuções agendadas. Cada calendário tem um nome, um fuso horário e uma lista de datas excluídas.

Resumo

uip or calendars <verb> [options]
uip or calendars <verb> [options]

Verbo

TextoFinalidade
listListe calendários no tenant.
getBusca um calendário por chave, incluindo as datas excluídas.
createCrie um calendário com um fuso horário opcional.
updateRenomear ou alterar o fuso horário de um calendário por chave.
deleteExclua um calendário por chave.

Todos os verbos honram as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

uip ou lista de calendários

Liste todos os calendários no tenant. Retorna os campos de resumo (id, name, timeZoneId, excludedDates, key). Use calendars get para um único calendário.

Opções

ShortLongValorPadrãoDescription
-t--tenantnamepadrão da sessãoSubstituir o tenant.
-l--limitNúmero50Tamanho da página
--offsetNúmero0Ignorar contagem.

Exemplos

uip or calendars list
uip or calendars list --limit 100
uip or calendars list --output-filter 'Data[].{k:key, n:name}'
uip or calendars list
uip or calendars list --limit 100
uip or calendars list --output-filter 'Data[].{k:key, n:name}'

Formato dos dados (--output json)

{
  "Code": "CalendarList",
  "Data": [
    {
      "name": "US Holidays",
      "timeZoneId": "America/New_York",
      "excludedDates": ["2025-07-04", "2025-12-25"],
      "key": "a1b2c3d4-0000-0000-0000-000000000001",
      "id": 1001
    }
  ]
}
{
  "Code": "CalendarList",
  "Data": [
    {
      "name": "US Holidays",
      "timeZoneId": "America/New_York",
      "excludedDates": ["2025-07-04", "2025-12-25"],
      "key": "a1b2c3d4-0000-0000-0000-000000000001",
      "id": 1001
    }
  ]
}

uip ou calendários get

Busca um calendário por chave GUID. Retorna detalhes completos, incluindo datas excluídas.

Argumentos

NameRequiredFinalidade
<calendar-key>simChave de calendário (GUID). Encontre-o com calendars list.

Opções

ShortLongValorPadrãoDescription
-t--tenantnamepadrão da sessãoSubstituir o tenant.

Exemplos

uip or calendars get a1b2c3d4-0000-0000-0000-000000000001
uip or calendars get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.excludedDates'
uip or calendars get a1b2c3d4-0000-0000-0000-000000000001
uip or calendars get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.excludedDates'

Formato dos dados (--output json)

{
  "Code": "CalendarGet",
  "Data": {
    "name": "US Holidays",
    "timeZoneId": "America/New_York",
    "excludedDates": ["2025-07-04", "2025-12-25"],
    "key": "a1b2c3d4-0000-0000-0000-000000000001",
    "id": 1001
  }
}
{
  "Code": "CalendarGet",
  "Data": {
    "name": "US Holidays",
    "timeZoneId": "America/New_York",
    "excludedDates": ["2025-07-04", "2025-12-25"],
    "key": "a1b2c3d4-0000-0000-0000-000000000001",
    "id": 1001
  }
}

criação de uip ou calendários

Crie um novo calendário. Os calendários têm o escopo de tenant. O fuso horário é UTC se --time-zone for omitido.

Argumentos

NameRequiredFinalidade
<name>simNome do calendário.

Opções

ShortLongValorPadrãoDescription
-t--tenantnamepadrão da sessãoSubstituir o tenant.
--time-zoneID tzUTCFuso horário do calendário (por exemplo, Europe/Bucharest).

Exemplos

uip or calendars create "EU Holidays" --time-zone "Europe/Bucharest"
uip or calendars create "US Holidays"
uip or calendars create "EU Holidays" --time-zone "Europe/Bucharest"
uip or calendars create "US Holidays"

Formato dos dados (--output json)

{
  "Code": "CalendarCreated",
  "Data": {
    "name": "EU Holidays",
    "timeZoneId": "Europe/Bucharest",
    "excludedDates": [],
    "key": "a1b2c3d4-0000-0000-0000-000000000010",
    "id": 1010
  }
}
{
  "Code": "CalendarCreated",
  "Data": {
    "name": "EU Holidays",
    "timeZoneId": "Europe/Bucharest",
    "excludedDates": [],
    "key": "a1b2c3d4-0000-0000-0000-000000000010",
    "id": 1010
  }
}
Observação:

Esse verbo cria o registro de calendário com uma lista excludedDates . O preenchimento de datas excluídas não é exposto por meio da CLI — use a interface gráfica do Orchestrator ou a API diretamente.

atualização de uip ou calendários

Atualize um calendário pela chave GUID. Apenas os campos que você fornece mudam; as demais são preservadas.

Argumentos

NameRequiredFinalidade
<calendar-key>simChave de calendário (GUID).

Opções

ShortLongValorPadrãoDescription
-t--tenantnamepadrão da sessãoSubstituir o tenant.
--nametextInalteradoNovo nome.
--time-zoneID tzInalteradoNovo fuso horário.

Exemplos

uip or calendars update a1b2c3d4-0000-0000-0000-000000000010 \
    --name "EU Public Holidays"

uip or calendars update a1b2c3d4-0000-0000-0000-000000000010 \
    --time-zone "Europe/Berlin"
uip or calendars update a1b2c3d4-0000-0000-0000-000000000010 \
    --name "EU Public Holidays"

uip or calendars update a1b2c3d4-0000-0000-0000-000000000010 \
    --time-zone "Europe/Berlin"

Formato dos dados (--output json)

{
  "Code": "CalendarUpdated",
  "Data": {
    "name": "EU Public Holidays",
    "timeZoneId": "Europe/Bucharest",
    "excludedDates": [],
    "key": "a1b2c3d4-0000-0000-0000-000000000010",
    "id": 1010
  }
}
{
  "Code": "CalendarUpdated",
  "Data": {
    "name": "EU Public Holidays",
    "timeZoneId": "Europe/Bucharest",
    "excludedDates": [],
    "key": "a1b2c3d4-0000-0000-0000-000000000010",
    "id": 1010
  }
}

exclusão de uip ou calendários

Exclui um calendário por chave GUID.

Argumentos

NameRequiredFinalidade
<calendar-key>simChave de calendário (GUID).

Opções

ShortLongValorPadrãoDescription
-t--tenantnamepadrão da sessãoSubstituir o tenant.

Exemplos

uip or calendars delete a1b2c3d4-0000-0000-0000-000000000010
uip or calendars delete a1b2c3d4-0000-0000-0000-000000000010

Formato dos dados (--output json)

{
  "Code": "CalendarDeleted",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Name": "EU Public Holidays",
    "Status": "Deleted successfully"
  }
}
{
  "Code": "CalendarDeleted",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Name": "EU Public Holidays",
    "Status": "Deleted successfully"
  }
}
  • uip or settingssettings timezones lista IDs de fuso horário válidos para --time-zone.

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