orchestrator
latest
false
- Introdução
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Processar solicitações de política de retenção de dados
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
Solicitações de calendários
Guia da API do Orchestrator
Last updated 23 de out de 2024
Solicitações de calendários
A solicitação GET a seguir para o terminal
/odata/Calendars
recupera um calendário específico com base em seu Name
.
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Calendars?$filter=Name%20eq%20'BankHoliday'
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "BankHoliday",
"Id": 18845
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "BankHoliday",
"Id": 18845
}
]
}
A solicitação POST a seguir para o terminal
/odata/Calendars
permite que você crie um novo calendário com uma data excluída.
Observação: o parâmetro
Id
é gerado automaticamente. O parâmetro TimeZoneId
é preenchido com o fuso horário do locatário.
Postar
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Calendars
{
"Name": "VacationCal",
"TimeZoneId": "string",
"ExcludedDates": [
"2019-11-12T14:31:44.778Z"
]
}
{
"Name": "VacationCal",
"TimeZoneId": "string",
"ExcludedDates": [
"2019-11-12T14:31:44.778Z"
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars/$entity",
"TimeZoneId": "GTB Standard Time",
"ExcludedDates": [
"2019-11-12T00:00:00Z"
],
"Name": "VacationCal",
"Id": 32718
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars/$entity",
"TimeZoneId": "GTB Standard Time",
"ExcludedDates": [
"2019-11-12T00:00:00Z"
],
"Name": "VacationCal",
"Id": 32718
}
O terminal GET
/odata/Calendars({calendar_id_value})
recupera as datas excluídas do calendário especificado.
Use o calendário
Id
para especificar o calendário do qual deseja recuperar as datas excluídas.
Para descobrir os
Id
s dos calendários existentes em seu locatário, primeiro faça uma solicitação GET para o terminal /odata/Calendars
.
Identifique o calendário desejado e copie o valor
Id
do corpo da resposta.
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Calendars
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "November_excluded_dates",
"Id": 1461
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "November_excluded_dates",
"Id": 1461
}
]
}
Para ver as datas excluídas, faça uma solicitação GET para o
/odata/Calendars({calendar_id_value})
.
Substitua
{calendar_id_value}
pelo valor Id
copiado anteriormente.
O corpo da resposta retorna todas as datas que foram excluídas no calendário especificado.
Por exemplo, para o calendário com o valor de ID de
1461
, a solicitação se parece com a seguinte:
Obter
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Calendars(1461)
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars/$entity",
"TimeZoneId": "UTC",
"ExcludedDates": [
"2021-11-01T00:00:00Z",
"2021-11-04T00:00:00Z",
"2021-11-08T00:00:00Z",
"2021-11-11T00:00:00Z",
"2021-11-15T00:00:00Z",
"2021-11-18T00:00:00Z",
"2021-11-22T00:00:00Z",
"2021-11-25T00:00:00Z"
],
"Name": "November_excluded_dates",
"Id": 1461
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars/$entity",
"TimeZoneId": "UTC",
"ExcludedDates": [
"2021-11-01T00:00:00Z",
"2021-11-04T00:00:00Z",
"2021-11-08T00:00:00Z",
"2021-11-11T00:00:00Z",
"2021-11-15T00:00:00Z",
"2021-11-18T00:00:00Z",
"2021-11-22T00:00:00Z",
"2021-11-25T00:00:00Z"
],
"Name": "November_excluded_dates",
"Id": 1461
}
- Recuperando calendários de acordo com seus nomes
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Criar um Calendário
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Corpo da Resposta
- Recuperando datas excluídas de um calendário
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta