- Primeros pasos
- Definición de Swagger
- Léeme
- Autorizar llamadas a API en Swagger
- Gestionar recursos lógicos
- 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 procesos
- Solicitudes de elementos en cola
- Solicitudes de robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- 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
Gestionar recursos lógicos
Para ver la respuesta y solicitar el esquema, haga clic en el botón Expandir operaciones junto al recurso en el que está interesado.
En la sección Clase de respuesta , puedes ver el modelo completo del recurso junto con explicaciones sobre cómo rellenar los parámetros, o un ejemplo de cómo puede ser la información que has solicitado.
La sección Parámetros contiene todos los parámetros disponibles admitidos por el recurso seleccionado, junto con una breve explicación. Además, todos los parámetros compatibles pueden rellenarse con información para que puedas probar la API de Orchestrator mientras lees la documentación.
Para ver todas las operaciones disponibles para un recurso específico, haz clic en el botón Enumerar operaciones situado junto al recurso de interés.
El modelo de respuesta de cualquier recurso está ahí para ayudarte a comprender su estructura y cómo utilizarlo en futuras solicitudes. Tiene la siguiente anatomía:
-
La entidad principal o Dto (objeto de transferencia de datos) y sus propiedades. Para cada propiedad, se muestra la siguiente información:
- el tipo de valor aceptado, escrito entre paréntesis;
- obligatorio u opcional: los parámetros opcionales están marcados como tales;
- una explicación sobre el parámetro y los valores máximos aceptados.
- La entidad de segundo nivel: solo se muestra si la entidad principal contiene un recurso como parámetro; Ten en cuenta que puede haber varias entidades de segundo nivel, dependiendo del recurso principal.
El número total de niveles de recursos depende de la entidad principal. Por ejemplo, RobotDto tiene tres niveles, mientras que EnvironmentDto tiene dos.