Skip to main content
POST
/
api
/
v1
/
ops
/
export-schedules
Create Export Schedule
curl --request POST \
  --url https://api.example.com/api/v1/ops/export-schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource": "<string>",
  "scopeType": "COMPANY",
  "format": "CSV",
  "columns": [
    "<string>"
  ],
  "filters": {},
  "scheduledAt": "2023-11-07T05:31:56Z",
  "fileNamePrefix": "<string>"
}
'
{
  "exportScheduledId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requestedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "<string>",
  "columns": [
    "<string>"
  ],
  "filters": {},
  "fileNamePrefix": "<string>",
  "scheduledAt": "2023-11-07T05:31:56Z",
  "failureReason": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Create scheduled export payload

​
resource
string
required
​
scopeType
enum<string>
required

Export scope type

Available options:
ORGANIZATION,
COMPANY,
COOPERATIVE,
BACKOFFICE
Example:

"COMPANY"

​
format
enum<string>
required

File format

Available options:
CSV,
XLSX
Example:

"CSV"

​
columns
string[]
required
​
filters
object
required
​
scheduledAt
string<date-time>
required
​
fileNamePrefix
string | null

Response

OK

Agendamento de exportação para execução futura

​
exportScheduledId
string<uuid>
required

Identificador único

​
organizationId
string<uuid> | null
required

Organização relacionada ao agendamento

​
companyId
string<uuid> | null
required

Empresa relacionada ao agendamento

​
cooperativeId
string<uuid> | null
required

Cooperativa relacionada ao agendamento

​
requestedByUserId
string<uuid>
required

Usuário que solicitou a exportação agendada

​
resource
string
required

Chave do recurso exportado, correspondente a ExportResource

​
scopeType
enum<string>
required

Escopo principal da exportação

Available options:
ORGANIZATION,
COMPANY,
COOPERATIVE,
BACKOFFICE
​
format
enum<string>
required

Formato do arquivo gerado

Available options:
CSV,
XLSX
​
columns
string[]
required

Colunas solicitadas para o arquivo

​
filters
object
required

Filtros aplicados à consulta

​
fileNamePrefix
string | null
required

Prefixo usado para montar o nome sugerido do arquivo gerado

​
scheduledAt
string<date-time>
required

Horário em que o job deve ser criado

​
failureReason
string | null
required

Motivo de falha quando o agendamento termina em FAILED

​
status
enum<string>
required

Status do agendamento

Available options:
SCHEDULED,
COMPLETED,
FAILED,
CANCELED
​
createdAt
string<date-time>
required

Data de criação

​
updatedAt
string<date-time>
required

Data da última atualização

​
deletedAt
string<date-time> | null
required

Data de remoção lógica