Executar fluxo manualmente

POST

/tenant/flows/run

Força a execução imediata de um flow específico.

Comportamento

1. Valida se o flow existe e está ativo
2. Envia comando de execução para o agente ETL
3. Retorna imediatamente (execução é assíncrona)

Importante: A execução é assíncrona. O retorno success: true indica
que o comando foi enviado, não que o flow foi concluído.

Parâmetro Context

O campo context é obrigatório e define o modo de carga do flow:

Context	Descrição
Total	Carga total - substitui todos os dados
Incremental	Carga incremental - apenas novos/alterados
Temporal:*	Carga temporal - período específico

Formatos Temporais

Para cargas temporais, use o formato Temporal:tipo:valor:

Formato	Exemplo	Descrição
Temporal:Days:N	Temporal:Days:30	Últimos N dias
Temporal:Future:N	Temporal:Future:7	Próximos N dias
Temporal:Year:AAAA	Temporal:Year:2024	Ano específico
Temporal:Month:MM-AAAA	Temporal:Month:01-2024	Mês específico

Mensagens de Erro

Mensagem	Causa
Flow não encontrado	ID não existe ou flow está inativo

Autorizações

tenantBearerAuth

Token de acesso do tenant

TipoHTTP (bearer)

Corpo da Requisição

application/json

{

"flowId": 1,

"context": "Total"

}

Respostas

Comando de execução enviado

Tipo de Conteúdo

application/json

{

"status": "success",

"data": true

}

POST

/tenant/flows/run

Playground

Autorização

tenantBearerAuth

Corpo

Exemplos

Desenvolvido por VitePress OpenAPI