- Introdução
- Autenticação
- Definição do Swagger
- 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 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

Guia da API do Orchestrator
Define o estado de um trabalho.
|
Name |
Valor |
Description |
|---|---|---|
|
Pendente |
0 |
Trabalho na fila em um robô ocupado ou desconectado. |
|
Em execução |
1 |
Trabalho atualmente processado por um robô. |
|
Parando |
2 |
trabalho acionado para cancelar assim que estiver seguro. Isso pode ser implementado em um fluxo de trabalho usando a atividade Deve Parar. |
|
Terminando |
3 |
Trabalho acionado para parar com força. Isso pode levar alguns segundos e o processo é encerrado. A parada segura não é garantida. |
|
Com falha |
4 |
Tarefa que falhou ao iniciar ou o fluxo de trabalho associado gerou um erro não tratado durante a execução. |
|
Bem-sucedido |
5 |
Trabalho que concluiu o processamento sem nenhuma exceção. |
|
Interrompido |
6 |
O trabalho parou antes de terminar a execução sem lançar nenhum erro. |
|
Suspenso |
7 |
Um estado intermediário que é acionado com a finalidade de permitir a intervenção do usuário ou a conclusão de um processo intermediário. Ele é acionado pelas atividades correspondentes no Studio. |
|
Retomado |
8 |
Um estado intermediário que é disparado se as condições (intervenção do usuário, conclusão do processo intermediário) de um fluxo de trabalho fragmentado tiverem sido atendidas. Ele é acionado pelas atividades correspondentes no Studio. |
|
Name |
Valor |
Description |
|---|---|---|
|
Manual |
0 |
Oo trabalho foi iniciado e configurado a partir das páginas Trabalhos/Gatilhos/Processos usando o botão Iniciar. |
|
Gatilho |
1 |
O trabalho foi iniciado por meio de um gatilho, usado para execução de trabalho pré-planejado. |
Define o estado de disponibilidade do Robô.
|
Name |
Valor |
Description |
|---|---|---|
|
Disponível |
0 |
Um robô funcional que pode ser usado gratuitamente. |
|
Ocupado |
1 |
Um robô que está executando um processo. |
|
Desconectado |
2 |
Um robô que está desconectado do Orchestrator. |
|
Desconhecido |
3 |
Um robô que está em um estado desconhecido. |
Define o estado de processamento de um item de fila.
|
Name |
Valor |
Description |
|---|---|---|
|
Novo |
0 |
O estado de um item recém-adicionado. |
|
InProgress |
1 |
O estado de um item que está sendo processado. |
|
Com falha |
2 |
O estado de um item cujo processamento falhou. |
|
Bem-sucedido |
3 |
O estado de um item cujo processamento foi bem-sucedido. |
|
Abandonado |
4 |
O estado de um item cujo processamento foi interrompido antes de ser bem-sucedido ou falhar. |
|
Repetido |
5 |
O estado de um item que foi processado pelo menos duas vezes. |
|
Excluído |
6 |
O estado de um item que foi marcado como excluído pelo usuário. |
Define categorias para a exceção lançada quando o processamento do item falha.
|
Name |
Valor |
Description |
|---|---|---|
|
Exceção de Aplicativo |
0 |
Lançado quando o processo falha devido a um erro de aplicativo. |
|
Exceção de Negócio |
1 |
Lançado quando um requisito de negócios não é atendido. |
|
Name |
Valor |
Description |
|---|---|---|
|
Nenhum |
0 |
Estado padrão aplicável a todos os tipos de itens. |
|
Em Revisão |
1 |
Um item neste estado falhou com uma exceção de aplicativo e foi marcado por um usuário como em processo de revisão. |
|
Verificado |
2 |
Um item neste estado falhou com uma exceção de aplicativo e foi marcado por um usuário como verificado e não pode mais ser repetido. Para ser repetido, um item deve ser marcado manualmente para nova tentativa. |
|
Repetido |
3 |
Um item neste estado falhou com uma exceção de aplicativo e foi marcado para nova tentativa. |
Define o nível de visibilidade de um ativo.
|
Name |
Valor |
Description |
|---|---|---|
|
Global |
0 |
Se um ativo tiver escopo global, ele ficará visível para todos os robôs. |
|
Por Robô |
1 |
Se um ativo tiver escopo PerRobot, ele ficará visível apenas para determinados robôs, aos quais foi associado e poderá ter valores diferentes para cada robô. |
Define que tipo de valor é armazenado por um ativo.
|
Name |
Valor |
Description |
|---|---|---|
|
Texto |
2 |
Define um recurso que armazena um valor de texto. |
|
Bool |
3 |
Define um ativo que armazena um valor Booleano. |
|
Número inteiro |
4 |
Define um ativo que armazena um valor numérico. |
|
Credencial |
5 |
Define um ativo que armazena um nome de usuário e senha. |
Define a severidade do log.
|
Name |
Valor |
Description |
|---|---|---|
|
Trace |
0 |
Informações refinadas. |
|
Depuração |
1 |
Informações detalhadas sobre o fluxo através do sistema. |
|
Informações |
2 |
Eventos de tempo de execução, como inicialização ou desligamento. A grande maioria das entradas de log. |
|
Warn |
3 |
Situações de tempo de execução indesejáveis ou inesperadas, mas não necessariamente erradas. |
|
Erro |
4 |
Erros de tempo de execução ou condições inesperadas. |
|
Fatal |
5 |
Erros graves que causam rescisão prematura. |
Define como um usuário foi criado e como deve ser usado.
|
Name |
Valor |
Description |
|---|---|---|
|
Usuário |
0 |
Um usuário do tipo Usuário local. |
|
Robô |
1 |
Criado automaticamente ao adicionar um robô, recebe a função de robô e é usado por um robô ao se comunicar com o orquestrador. |
|
DirectoryUser |
2 |
Um usuário do tipo Usuário do diretório |
|
DirectoryGroup |
3 |
Um usuário do tipo Grupo de Diretório |