UiPath Documentation
orchestrator
latest
false
Guia da API do Orchestrator
Importante :
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Solicitações de calendários

Pontos de extremidade de API para recuperar e filtrar calendários por nome.

Recuperação de calendários de acordo com o nome​

A solicitação GET a seguir para o terminal /odata/Calendars recupera um calendário específico com base em seu Name.

Obter

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars?$filter=Name%20eq%20'BankHoliday'

Cabeçalhos de solicitação.​

ChaveValor
AutorizaçãoO portador

Código de resposta​

200 OK

Corpo da Resposta​

{
  "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
  "value": [
    {
      "TimeZoneId": null,
      "ExcludedDates": [],
      "Name": "BankHoliday",
      "Id": 18845
    }
  ]
}
{
  "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
  "value": [
    {
      "TimeZoneId": null,
      "ExcludedDates": [],
      "Name": "BankHoliday",
      "Id": 18845
    }
  ]
}

Criar um Calendário​

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 tenant.

Postar

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars

Cabeçalhos de solicitação.​

ChaveValor
AutorizaçãoO portador

Corpo da Solicitação​

{
  "Name": "VacationCal",
  "TimeZoneId": "string",
  "ExcludedDates": [
    "2019-11-12T14:31:44.778Z"
  ]
}
{
  "Name": "VacationCal",
  "TimeZoneId": "string",
  "ExcludedDates": [
    "2019-11-12T14:31:44.778Z"
  ]
}

Código de resposta​

200 OK

Corpo da Resposta​

{
  "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars/$entity",
  "TimeZoneId": "GTB Standard Time",
  "ExcludedDates": [
    "2019-11-12T00:00:00Z"
  ],
  "Name": "VacationCal",
  "Id": 32718
}
{
  "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars/$entity",
  "TimeZoneId": "GTB Standard Time",
  "ExcludedDates": [
    "2019-11-12T00:00:00Z"
  ],
  "Name": "VacationCal",
  "Id": 32718
}

Recuperação de datas excluídas de um calendário​

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 Ids 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

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars

Cabeçalhos de solicitação.​

ChaveValor
AutorizaçãoO portador

Código de resposta​

200 OK

Corpo da Resposta​

{
    "@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
    "value": [
        {
            "TimeZoneId": null,
            "ExcludedDates": [],
            "Name": "November_excluded_dates",
            "Id": 1461
        }
    ]
}
{
    "@odata.context": "{AutomationCloudURL}/{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

{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars(1461)

Cabeçalhos de solicitação.​

ChaveValor
AutorizaçãoO portador

Código de resposta​

200 OK

Corpo da Resposta​

{
    "@odata.context": "{AutomationCloudURL}/{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": "{AutomationCloudURL}/{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
}

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades