Create Export Job - Documentação DEVMOB

curl --request POST \ --url https://api.example.com/api/v1/ops/export-jobs \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "resource": "<string>", "scopeType": "COMPANY", "format": "CSV", "columns": [ "<string>" ], "filters": {}, "fileNamePrefix": "<string>" } '

{ "exportJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "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": {}, "fileKey": "<string>", "fileName": "<string>", "contentType": "<string>", "sizeBytes": 123, "totalRows": 123, "failureReason": "<string>", "expiresAt": "2023-11-07T05:31:56Z", "startedAt": "2023-11-07T05:31:56Z", "finishedAt": "2023-11-07T05:31:56Z", "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 export job 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

fileNamePrefix

string | null

Response

Solicitação de exportação, status e arquivo final gerado

exportJobId

string<uuid>

required

Identificador único

exportScheduledId

string<uuid> | null

required

Agendamento que originou o job, quando aplicável

organizationId

string<uuid> | null

required

Organização relacionada ao job

companyId

string<uuid> | null

required

Empresa relacionada ao job

cooperativeId

string<uuid> | null

required

Cooperativa relacionada ao job

requestedByUserId

string<uuid>

required

Usuário que solicitou a exportação

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

fileKey

string | null

required

Chave do arquivo final em storage

fileName

string | null

required

Nome sugerido para download

contentType

string | null

required

MIME type do arquivo final

sizeBytes

integer | null

required

Tamanho do arquivo final em bytes

totalRows

integer | null

required

Total de linhas escritas no arquivo

failureReason

string | null

required

Motivo de falha quando o job termina em FAILED

status

enum<string>

required

Status da exportação

Available options:

PENDING,

QUEUED,

RUNNING,

COMPLETED,

FAILED,

EXPIRED,

CANCELED

expiresAt

string<date-time> | null

required

Data limite de disponibilidade do arquivo

startedAt

string<date-time> | null

required

Data em que o worker iniciou a exportação

finishedAt

string<date-time> | null

required

Data em que o job chegou a um status terminal

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