- Introdução
- Autenticação
- Definição do Swagger
- Leia-me
- Como autorizar chamadas de API no Swagger
- Gerenciamento de recursos lógicos
- APIs do Orchestrator
- Solicitações de alertas
- 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 itens de fila
- 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
- APIs de gestão de plataforma
Gerenciamento de recursos lógicos
Para visualizar o esquema de resposta e solicitação, clique no botão Expandir operações ao lado do recurso de seu interesse.
Na seção Classe de resposta , você pode visualizar todo o modelo do recurso junto com explicações sobre como preencher os parâmetros ou um exemplo de como as informações que você solicitou podem parecer.
A seção Parâmetros contém todos os parâmetros disponíveis suportados pelo recurso selecionado, juntamente com uma breve explicação. Além disso, todos os parâmetros com suporte podem ser preenchidos com informações para que você possa realmente experimentar a API do Orchestrator enquanto lê a documentação.
Para visualizar todas as operações disponíveis para um recurso específico, clique no botão Listar operações ao lado do recurso de interesse.
O modelo de resposta de qualquer recurso existe para ajudá-lo a entender sua estrutura e como usá-lo em solicitações futuras. Possui a seguinte anatomia:
-
A entidade principal ou Dto (objeto de transferência de dados) e suas propriedades. Para cada propriedade, as seguintes informações são exibidas:
- o tipo de valor aceito, escrito entre parênteses;
- obrigatório ou opcional - os parâmetros opcionais são marcados como tal;
- uma explicação sobre o parâmetro e os valores máximos aceitos.
- A entidade de segundo nível - exibida apenas se a entidade principal contiver um recurso como parâmetro; Observe que pode haver várias entidades de segundo nível, dependendo do recurso principal.
O número total de níveis de recursos depende da entidade principal. Por exemplo, RobotDto tem três níveis, enquanto EnvironmentsDto tem dois.
