- Introdução
- Sobre OData e referências
- URL do Orchestrator
- Tipos enumerados
- Autenticando
- Criação de solicitações de API
- Permissões por endpoint
- Códigos de resposta
- Pontos de extremidade de verificação de integridade
- Definição do Swagger
- Leia-me
- Como autorizar chamadas de API no Swagger
- Gerenciamento de recursos lógicos
- APIs do Orchestrator
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de processos
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
Guia da API do Orchestrator
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 melhores práticas para construir e consumir 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.
Para obter mais informações sobre princípios e definições de protocolo, recomendamos verificar a documentação oficial do OData.
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.
Operações 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.
Solicitando 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 que você consulte, filtre, classifique, selecione e expanda 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 estatísticos fornecem informações agregadas sobre diferentes entidades;
- Os métodos de conta fornecem métodos de autenticação ao orquestrador;
- Os métodos Queues são usados pelo Robot para acessar as filas, enquanto o endpoint
QueueDefinitionsdeve ser usado para sistemas externos via API; - Os métodos QueueProcessingRecords oferecem informações estatísticas e agregadas sobre as filas;
- Os recursosRobotsService podem ser usados pelo Orchestrator para se comunicar com o Robot.