Skip to content

Listar agendamentos ETL

GET
/tenant/etl-schedules

Retorna todos os agendamentos (schedules) do tenant com seus flows e triggers.

O que são Schedules?

Schedules são agendamentos de execução que definem quando e como os flows
devem ser executados automaticamente. Um schedule pode conter múltiplos flows
que serão executados em sequência.

Campos Retornados

Campo Descrição
id ID do agendamento
nome Nome do agendamento
ativo Se o agendamento está ativo
flows Lista de flows vinculados (em ordem de execução)
triggers Configurações de gatilho (quando executar)

Campos do Trigger

Campo Descrição
type Tipo de trigger (timer, cron, etc.)
period Intervalo em minutos (para triggers periódicos)
start_time Hora de início (HH:MM)
end_time Hora de término (HH:MM)
start_when Data/hora de início do agendamento

Autorizações

tenantBearerAuth

Token de acesso do tenant

TipoHTTP (bearer)

Respostas

Lista de agendamentos retornada com sucesso

application/json
JSON
{
"status": "success",
"data": [
{
"id": 1,
"nome": "Carga Diária 6h",
"ativo": true,
"flows": [
{
"flowId": 1
},
{
"flowId": 2
}
],
"triggers": [
{
"type": "timer",
"period": 1440,
"start_time": "06:00",
"end_time": null,
"start_when": "2024-01-01T06:00:00Z"
}
]
},
{
"id": 2,
"nome": "Carga Horária",
"ativo": true,
"flows": [
{
"flowId": 3
}
],
"triggers": [
{
"type": "timer",
"period": 60,
"start_time": "08:00",
"end_time": "20:00",
"start_when": null
}
]
}
]
}

Playground

Autorização

Exemplos

Desenvolvido por VitePress OpenAPI