Skip to main content
O ExportScheduled representa uma exportação agendada. Ele mantém o núcleo de solicitação de um ExportJob, adicionando o horário de execução e metadados necessários para gerar o arquivo futuro.

​
Campos

CampoTipoDescrição
exportScheduledIdUUIDIdentificador único
organizationIdUUID?Organização relacionada ao agendamento
companyIdUUID?Empresa relacionada ao agendamento
cooperativeIdUUID?Cooperativa relacionada ao agendamento
requestedByUserIdUUIDUsuário que solicitou a exportação agendada
resourceStringChave do recurso exportado, correspondente a ExportResource
scopeTypeDataTransferScopeTypeEscopo principal da exportação
formatDataTransferFileFormatFormato do arquivo gerado
columnsString[]Colunas solicitadas para o arquivo
filtersJsonFiltros aplicados à consulta
fileNamePrefixString?Prefixo usado para montar o nome sugerido do arquivo gerado
scheduledAtDateTimeHorário em que o job deve ser criado
failureReasonString?Motivo de falha quando o agendamento termina em FAILED
statusExportScheduledStatusStatus do agendamento
createdAtDateTimeData de criação
updatedAtDateTimeData da última atualização
deletedAtDateTime?Data de remoção lógica

​
Relacionamentos

  • Relaciona-se com Organization, quando o escopo exigir organização.
  • Relaciona-se com Company, quando o escopo for COMPANY.
  • Relaciona-se com Cooperative, quando o escopo for COOPERATIVE.
  • Relaciona-se com User por requestedByUserId.
  • Referencia ExportResource por resource.
  • Pode originar um ExportJob quando scheduledAt for alcançado.

​
Regras de Negócio

  • resource deve existir como catálogo ativo em ExportResource.
  • scopeType define quais identificadores de escopo são obrigatórios.
  • columns deve ser subconjunto das colunas permitidas no catálogo.
  • filters deve respeitar os campos e operadores permitidos no catálogo.
  • fileNamePrefix deve ser usado para compor o fileName do ExportJob, quando informado.
  • scheduledAt deve ser uma data futura no momento da criação do agendamento.
  • Quando o agendamento for executado, deve ser criado um ExportJob com os mesmos campos de escopo, recurso, formato, colunas e filtros.
  • CANCELED, COMPLETED, FAILED ou deletedAt impedem nova execução do agendamento.

​
Enums

​
DataTransferScopeType

ValorDescrição
ORGANIZATIONOperação limitada a uma organização
COMPANYOperação limitada a uma empresa
COOPERATIVEOperação limitada a uma cooperativa
BACKOFFICEOperação administrativa

​
DataTransferFileFormat

ValorDescrição
CSVArquivo CSV
XLSXPlanilha Excel

​
ExportScheduledStatus

ValorDescrição
SCHEDULEDAgendamento criado e aguardando execução
COMPLETEDJob criado a partir do agendamento
FAILEDFalha ao criar o job agendado
CANCELEDAgendamento cancelado antes da execução

​
Example

{
  "exportScheduledId": "0197f605-98dd-71e8-9666-0d9f6c719b95",
  "organizationId": "0197a801-1690-7590-b3cf-19599b9be3e4",
  "companyId": "0197a801-6a42-79aa-9e56-d3c85148c0fa",
  "cooperativeId": null,
  "requestedByUserId": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "resource": "order",
  "scopeType": "COMPANY",
  "format": "CSV",
  "columns": ["code", "status", "totalAmount", "createdAt"],
  "filters": {
    "status": {
      "operator": "IN",
      "value": ["PAID", "CANCELED"]
    }
  },
  "fileNamePrefix": "pedidos-agendados",
  "scheduledAt": "2026-07-05T09:00:00.000Z",
  "failureReason": null,
  "status": "SCHEDULED",
  "createdAt": "2026-07-04T08:30:00.000Z",
  "updatedAt": "2026-07-04T08:30:00.000Z",
  "deletedAt": null
}