- Introdução
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de tarefas de aplicativo
- 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 espaços de trabalho pessoais
- Solicitações de processos
- Processar solicitações de política de retenção de dados
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- 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
Leia-me
We plan to upgrade the Orchestrator Swagger version to Swagger 3.0. Currently, Orchestrator APIs are defined using Swagger 2.0. Do not worry about backwards compatibility with your existing API clients: we will ensure the API remains compatible. We recommend using your previous clients, as JSON changes do not alter them, thanks to our request structure backwards compatibility. After the Swagger 3.0 update, all regenerated API clients based on the new JSON definition will have to be readjusted.
Se você planeja integrar nossas APIs com seu cliente, precisa estar ciente das possíveis atualizações e alterações que podem ocorrer na definição do Swagger, esquemas JSON ou terminais de API.
A lista abaixo fornece informações e recomendações sobre alterações do Swagger. Se tiver outras dúvidas, entre em contato com nossa equipe de suporte.
Informações e recomendações sobre as alterações do Swagger
- A descrição da API JSON representada no documento Swagger JSON pode mudar a qualquer momento. No entanto, ele descreverá a mesma API subjacente, para garantir a compatibilidade com versões anteriores.
- A interface Swagger e o JSON correspondente são gerados com base nos endpoints atuais e sempre publicamos a versão mais recente. Para garantir a compatibilidade com versões anteriores, oferecemos suporte à mesma estrutura de solicitação.
- Como alternativa aos clientes API gerados em tempo de execução, use clientes API fixos ou em tempo de compilação. Isso reduz a dependência e evita grandes atualizações de automação caso a API ou a definição do Swagger sejam alteradas.
- Os itens marcados como obsoletos estão disponíveis por um tempo limitado, após o qual os itens são removidos da definição do Swagger e da API JSON.
- Sempre que certas APIs mudam internamente, uma nova versão da Swagger API é publicada. O número da versão da API não influencia o uso da API do cliente. Não recomendamos depender do controle de versão da API.
Exemplos de API
Os exemplos fornecidos no documento de referência existente do Orchestrator descrevem cenários e endpoints complexos.
Você pode ver todas as APIs disponíveis no Swagger JSON, que contém as atualizações mais recentes.