Buscar K
Aparência
Executar um Dataflow
POST
/tenant/flows/run
Dispara agora um Dataflow do Tenant. A resposta volta antes da carga terminar.
data: true só confirma o pedido. Se a carga terminou e se o agente estava online,
você acompanha pelo executionId em GET /tenant/executions/{id}: agente offline
ou recusa aparecem lá, com errorCode, e o status HTTP continua 200.
Disparar de novo um Dataflow que ainda está rodando pela API não começa outra carga:
a resposta traz o executionId da execução aberta, com alreadyRunning: true.
O campo context
context é obrigatório e diz o que esta execução traz da origem. Fora do Total, o
que a carga faz com a tabela depende da Gravação do Dataflow; as regras estão em
Tipos de carga.
context |
O que traz |
|---|---|
Total |
A origem inteira. Troca toda a parte do Dataflow na tabela, qualquer que seja a Gravação |
Incremental |
O que mudou desde a última carga |
Temporal:* |
Um intervalo de datas (na tela, Janela) |
A janela vai no formato Temporal:tipo:valor:
| Formato | Exemplo | Janela |
|---|---|---|
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 |
O ano inteiro |
Temporal:Month:MM-AAAA |
Temporal:Month:01-2024 |
O mês inteiro |
Mensagens de erro
code |
Status | Causa |
|---|---|---|
FLOW_NOT_FOUND |
404 | O id não existe neste Tenant ou o Dataflow está inativo |
Autorizações
tenantBearerAuth
Token de acesso do tenant
TipoHTTP (bearer)
Corpo da Requisição
application/json
JSON
Respostas
Pedido aceito. O resultado fica na execução
application/json
JSON