orchestrator
2023.10
false
- Primeros pasos
- Autenticación
- Definición de Swagger
- API de Orchestrator
- Solicitudes de alertas
- Solicitudes de activos
- Solicitudes de calendario
- Solicitudes de entornos
- Solicitudes de carpetas
- Solicitudes de tareas genéricas
- Solicitudes de trabajos
- Solicitudes de bibliotecas
- Solicitudes de licencia
- Solicitudes de paquetes
- Solicitudes de permisos
- Solicitudes de espacios de trabajo personales
- Solicitudes de procesos
- Solicitudes de elementos en cola
- Solicitudes de política de retención de cola
- Solicitudes de robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- Solicitudes de cubos de almacenamiento
- Solicitudes de tareas
- Solicitudes de catálogos de tareas
- Solicitudes de formularios de tareas
- Solicitudes de tenants
- Solicitudes de transacciones
- Solicitudes de usuario
- Solicitudes de Webhooks
- API de gestión de plataformas
Solicitudes de calendario
Guía de la API de Orchestrator
Last updated 17 de jun. de 2024
Solicitudes de calendario
La siguiente solicitud GET al punto final
/odata/Calendars
recupera un calendario específico según su Name
.
Obtener
https://{yourDomain}/odata/Calendars?$filter=Name%20eq%20'BankHoliday'
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "BankHoliday",
"Id": 18845
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "BankHoliday",
"Id": 18845
}
]
}
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}/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://{yourDomain}/odata/$metadata#Calendars/$entity",
"TimeZoneId": "GTB Standard Time",
"ExcludedDates": [
"2019-11-12T00:00:00Z"
],
"Name": "VacationCal",
"Id": 32718
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Calendars/$entity",
"TimeZoneId": "GTB Standard Time",
"ExcludedDates": [
"2019-11-12T00:00:00Z"
],
"Name": "VacationCal",
"Id": 32718
}
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
Id
de 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}/odata/Calendars
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "November_excluded_dates",
"Id": 1461
}
]
}
{
"@odata.context": "https://{yourDomain}/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}/odata/Calendars(1461)
{
"@odata.context": "https://{yourDomain}/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://{yourDomain}/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
}
- Recuperar calendarios según su nombre
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta
- Crear un Calendario
- Solicitar encabezados.
- Solicitar cuerpo
- Código de respuesta
- Cuerpo de respuesta
- Recuperar fechas excluidas de un calendario
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta