- 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 gravações de vídeo
- Solicitações de webhooks
Notas de especificação da API do Orchestrator, incluindo a atualização do OpenAPI 3.0 e o cronograma de descontinuação para a especificação do Swagger 2.0 anterior.
A especificação de API padrão do Orchestrator é compatível com o OpenAPI 3.0. A especificação anterior (V20, baseada no Swagger 2.0) está obsoleta e permanece disponível por um tempo limitado para compatibilidade com versões anteriores. Consulte Linha do tempo de descontinuação abaixo para obter datas exatas. Após migrar para a nova especificação, todos os clientes de API regenerados com base na nova definição JSON terão que ser reajustados.
Se você planeja integrar nossas APIs ao seu cliente, você precisa estar ciente das possíveis atualizações e alterações que podem acontecer na especificação da API, esquemas JSON ou pontos de extremidade da API.
A lista a seguir fornece informações e recomendações sobre alterações de especificação de API. Se tiver outras dúvidas, entre em contato com nossa equipe de suporte.
Cronograma de descontinuação
| Modelo de entrega | Obsoleto | removido |
|---|---|---|
| Automation Cloud | Agosto de 2026 | Setembro de 2026 |
| Automation Suite | Versão 2.2610 | Versão 2.2610 |
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.