Sobre OData e referências

A implementação da API do Orchestrator é baseada no protocolo OData. OData (Open Data Protocol) é um padrão OASIS aprovado pela ISO/IEC que define um conjunto de práticas recomendadas para criação e consumo de APIs RESTful.

O Open Data Protocol (OData) permite a criação de serviços de dados baseados em REST, que permitem que recursos, identificados usando URLs e definidos em um modelo de dados, sejam publicados e editados por clientes Web usando mensagens HTTP simples. Esta especificação define a semântica central e os aspectos comportamentais do protocolo.

O formato padrão para o endpoint de metadados OData do Orchestrator é JSON e o URL de metadados é https://{yourDomain}/odata.Para alterar o formato padrão para XML, adicione /?$format=xml a este URL.

Para obter mais informações sobre princípios e definições de protocolo, recomendamos verificar a documentação oficial do OData.

Observação:

Nosso objetivo é estar em conformidade com o padrão OData, mas não podemos garantir isso. Embora o padrão exija que o endpoint de metadados retorne o formato XML por padrão, retornamos JSON para compatibilidade histórica.

Recursos lógicos e metadados

A API do Orchestrator fornece métodos personalizados para consultar estatísticas sobre várias entidades registradas no Orchestrator. Cada recurso lógico é uma entidade OData. Todas as entidades (como Robô, Processo, Fila) têm propriedades, relacionamentos e operações.

Figura 1. Modelo de dados da estrutura de entidade do Orchestrator

Operações disponíveis

Operações de CRUD

Esses tipos de operações estão disponíveis na maioria dos recursos lógicos. As operações CRUD incluem solicitações GET, POST, PUT e DELETE, mas observe que nem todos os recursos lógicos usam todos esses verbos por motivos técnicos e comerciais.

Solicitação de dados

É possível solicitar informações específicas de um recurso específico, em conjunto com operações GET, por meio de parâmetros específicos do OData.

Eles permitem consultar, filtrar, classificar, selecionar e expandir informações. Mais detalhes podem ser encontrados na documentação oficial do OData.

Ações Personalizadas

As seguintes ações personalizadas e ações que não estão vinculadas a um recurso lógico estão disponíveis na API do orquestrador:

• Os métodos Stats fornecem informações agregadas sobre diferentes entidades;
• Os métodos Account fornecem métodos de autenticação para o Orchestrator;
• Os métodos Queue são usados pelo Robô para acessar filas, enquanto o ponto de extremidade QueueDefinitions deve ser usado para sistemas externos via API;
• Os métodos QueueProcessingRecords oferecem informações estatísticas e agregadas sobre filas;
• Os recursos do RobotsService podem ser usados pelo Orchestrator para se comunicar com o Robô.

Figura 2. Métodos da API do Orchestrator personalizados