Skip to main content
POST
Iniciar uma extração de conexão

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

Parâmetros de caminho

connectionId
string
obrigatório

The unique identifier of the connection.

Corpo

application/json

Payload da requisição de extração

Payload da requisição para iniciar uma extração de dados a partir de uma conexão descoberta

tables
object
obrigatório

Tabelas das quais extrair dados, indexadas pelo nome da tabela; pelo menos uma entrada é obrigatória

startDate
string

Início do intervalo de datas a extrair (RFC 3339)

endDate
string

Fim do intervalo de datas a extrair (RFC 3339)

filters
object

Filtros opcionais em nível de linha para uma extração

Resposta

Requisição de extração criada

Uma requisição de extração enviada ao Fetcher

id
string

Identificador interno da requisição de extração

connectionId
string

Conexão para a qual esta extração foi enviada

status
string

Status atual do ciclo de vida da extração

ingestionJobId
string

Identificador do job retornado pelo Fetcher

startDate
string

Início do intervalo de datas extraído

endDate
string

Fim do intervalo de datas extraído

tables
object

Status de extração por tabela

filters
object

Filtros opcionais em nível de linha para uma extração

errorMessage
string

Detalhes do erro caso a extração tenha falhado

createdAt
string

Timestamp em que a extração foi solicitada

updatedAt
string

Timestamp da última atualização de status