Calendars requests

Retrieving calendars according to their name

La siguiente solicitud GET al punto final /odata/Calendars recupera un calendario específico según su Name.

Obtener

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

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

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

Creating a calendar

La siguiente solicitud POST al punto final /odata/Calendars te permite crear un nuevo calendario con una fecha excluida.

Nota: El parámetro Id se genera automáticamente. El parámetro TimeZoneId se rellena con la zona horaria del tenant.

Publicar

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Solicitar cuerpo

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

Código de respuesta

200 OK

Cuerpo de respuesta

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

Retrieving excluded dates of a calendar

El punto final GET /odata/Calendars({calendar_id_value}) recupera las fechas excluidas del calendario especificado.

Usa el calendario Id para especificar el calendario del que quieres recuperar las fechas excluidas.

Para averiguar los Idde los calendarios existentes en su tenant, realiza primero una solicitud GET al punto final /odata/Calendars .

Identifique el calendario deseado y copie el valor Id del cuerpo de la respuesta.

Obtener

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Calendars",
    "value": [
        {
            "TimeZoneId": null,
            "ExcludedDates": [],
            "Name": "November_excluded_dates",
            "Id": 1461
        }
    ]
}

Para ver las fechas excluidas, realiza una solicitud GET a /odata/Calendars({calendar_id_value}).

Reemplaza {calendar_id_value} con el valor Id copiado previamente.

El cuerpo de la respuesta devuelve todas las fechas que se han excluido en el calendario especificado.

Por ejemplo, para el calendario con el valor de ID de 1461, la solicitud se ve a continuación:

Obtener

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Calendars(1461)

Solicitar encabezados.

Clave	Valor
Autorización	Portador

Código de respuesta

200 OK

Cuerpo de respuesta

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