Sobre OData y referencias

La implementación de la API de Orchestrator se basa en el protocolo OData. OData (Protocolo de datos abiertos) es un estándar OASIS aprobado por ISO/IEC que define un conjunto de prácticas recomendadas para crear y consumir API RESTful.

El Open Data Protocol (OData) permite la creación de servicios de datos basados en REST, que permiten que los recursos identificados mediante URL y definidos en un modelo de datos sean publicados y editados por clientes web utilizando simples mensajes HTTP. Esta especificación define la semántica central y los aspectos de comportamiento del protocolo.

El formato predeterminado para el punto final de metadatos OData de Orchestrator es JSON y la URL de metadatos es https://{yourDomain}/odata. Para cambiar el formato predeterminado a XML, añade /?$format=xml a esta URL.

Para obtener más información sobre los principios y definiciones de protocolo, recomendamos consultar la documentación oficial de OData.

Nota:

Nuestro objetivo es cumplir con el estándar OData, pero no podemos garantizarlo. Aunque el estándar exige que el punto final de metadatos devuelva el formato XML de forma predeterminada, devolvemos JSON para la compatibilidad histórica.

Recursos lógicos y metadatos

La API de Orchestrator proporciona métodos personalizados para consultar estadísticas sobre varias entidades registradas en Orchestrator. Cada recurso lógico es una entidad de OData. Todas las entidades (como Robot, Proceso, Cola) tienen propiedades, relaciones y operaciones.

Operaciones disponibles

Operaciones CRUD

Estos tipos de operaciones están disponibles en la mayoría de los recursos lógicos. Las operaciones CRUD incluyen solicitudes GET, POST, PUT y DELETE, pero tenga en cuenta que no todos los recursos lógicos hacen uso de todos estos verbos debido a razones técnicas y comerciales.

Solicitar datos

Es posible solicitar información particular de un recurso particular, junto con las operaciones GET, mediante parámetros específicos de OData.

Te permiten consultar, filtrar, ordenar, seleccionar y ampliar información. Puedes encontrar más detalles en la documentación oficial de OData.

Acciones personalizadas

Las siguientes acciones personalizadas y las que no están vinculadas a un recurso lógico están disponibles en la API de Orchestrator:

• Los métodos de estadísticas proporcionan Information agregada sobre diferentes entidades;

• Los Métodos de cuenta proporcionan métodos de autenticación a Orchestrator;

• El robot utiliza los Métodos de cola para acceder a las colas, mientras que el punto final QueueDefinitions debe utilizarse en vez de ello para los sistemas externos a través de la API;

• Los métodos QueueProcessingRecords ofrecen información estadística y agregada sobre colas;

• Orchestrator puede utilizar los recursos de RobotsService para comunicarse con el robot.