- Primeros pasos
- Definición de Swagger
- API de Orchestrator
- Solicitudes de alertas
- Solicitudes de tareas de aplicaciones
- 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
- Procesar solicitudes de política de retención de datos
- 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
Guía de la API de Orchestrator
Léeme
We plan to upgrade the Orchestrator Swagger version to Swagger 3.0. Currently, Orchestrator APIs are defined using Swagger 2.0. Do not worry about backwards compatibility with your existing API clients: we will ensure the API remains compatible. We recommend using your previous clients, as JSON changes do not alter them, thanks to our request structure backwards compatibility. After the Swagger 3.0 update, all regenerated API clients based on the new JSON definition will have to be readjusted.
Si planeas integrar nuestras API con tu cliente, debes conocer las posibles actualizaciones y cambios que pueden ocurrir en la definición de Swagger, los esquemas JSON o los puntos finales de la API.
La siguiente lista proporciona información y recomendaciones sobre los cambios de Swagger. Si tienes más preguntas, ponte en contacto con nuestro equipo de soporte.
Información y recomendaciones sobre cambios de Swagger
- La descripción de la API de JSON representada en el documento JSON de Swagger puede cambiar en cualquier momento. Sin embargo, describirá la misma API subyacente para garantizar la compatibilidad con versiones anteriores.
- La interfaz de Swagger y el JSON correspondiente se generan en función de los puntos de conexión actuales y siempre publicamos la última versión. Para garantizar la compatibilidad con versiones anteriores, admitimos la misma estructura de solicitud.
- Como alternativa a los clientes API generados en tiempo de ejecución, utiliza clientes API de tiempo fijo o de compilación. Al hacerlo, se reduce la dependencia y se evitan actualizaciones de automatización importantes en caso de que cambie la definición de la API o de Swagger.
- Los elementos marcados como obsoletos están disponibles durante un tiempo limitado, después del cual se eliminan de la definición de Swagger y la API de JSON.
- Cada vez que ciertas API cambian internamente, se publica una nueva versión de la API de Swagger. El número de versión de la API no influye en el uso de la API del cliente. No recomendamos confiar en el control de versiones de la API.
Ejemplos de API
Los ejemplos proporcionados en el documento de referencia de Orchestrator existente describen escenarios y puntos finales complejos.
Puedes ver todas las API disponibles en el Swagger JSON, que contiene las últimas actualizaciones.