Skip to main content
GET
/
api
/
v1
/
ops
/
export-resources
/
{resource}
Get Export Resource
curl --request GET \
  --url https://api.example.com/api/v1/ops/export-resources/{resource} \
  --header 'Authorization: Bearer <token>'
{
  "exportResourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "<string>",
  "label": "<string>",
  "description": "<string>",
  "permission": "<string>",
  "formats": [],
  "defaultColumns": [
    "<string>"
  ],
  "columns": [
    {
      "field": "<string>",
      "label": "<string>",
      "values": [
        "<string>"
      ],
      "sensitive": true
    }
  ],
  "filters": [
    {
      "field": "<string>",
      "label": "<string>",
      "operators": [],
      "values": [
        "<string>"
      ],
      "required": true
    }
  ],
  "maxRows": 123,
  "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.

Path Parameters

​
resource
string
required

Export resource key

Example:

"order"

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.

Response

OK

Catálogo de recursos exportáveis, colunas e filtros permitidos

​
exportResourceId
string<uuid>
required

Identificador único

​
resource
string
required

Chave estável do recurso exportável, como order, ticket, vehicle ou trip

​
label
string
required

Nome exibido para o usuário no fluxo de exportação

​
description
string | null
required

Descrição curta do recurso exportável

​
permission
string
required

Permission necessária para exportar o recurso

​
formats
enum<string>[]
required

Formatos disponíveis para geração

Available options:
CSV,
XLSX
​
defaultFormat
enum<string>
required

Formato pré-selecionado

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

Colunas selecionadas por padrão

​
columns
object[]
required

Colunas permitidas para exportação

​
filters
object[]
required

Filtros permitidos para consulta

​
maxRows
integer | null
required

Limite máximo de linhas por exportação

​
status
enum<string>
required

Status do catálogo

Available options:
ACTIVE,
INACTIVE
​
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