Skip to main content
GET
/
api
/
v1
/
schemas
/
{slug}
/
files
curl -X GET \
  "https://api.datasnap.cloud/api/v1/schemas/meu-schema/files?per_page=15&page=1&sort_by=created_at&sort_direction=desc" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": 123,
      "file_name": "dados_vendas.jsonl",
      "size_bytes": 2048576,
      "schema_version": "1.0.0",
      "storage_path": "/uploads/2024/08/dados_vendas.jsonl",
      "validation": "valid",
      "upload_status": "completed",
      "created_at": "2024-08-15T10:30:00Z",
      "updated_at": "2024-08-15T10:35:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 15,
    "to": 15,
    "total": 73
  },
  "success": true
}

​
Autenticação

Este endpoint requer autenticação. Inclua seu token Bearer no cabeçalho Authorization.
Authorization: Bearer SEU_TOKEN_AQUI

​
Parâmetros de Caminho

​
slug
string
required
O slug do schema

​
Parâmetros de Consulta

​
per_page
integer
default:"15"
Número de itens por página (1-100)
​
page
integer
default:"1"
Número da página (mínimo: 1)
​
search
string
Termo de busca para filtrar arquivos por nome, caminho ou status de upload
​
sort_by
string
default:"created_at"
Campo para ordenação. Opções: file_name, size_bytes, schema_version, storage_path, validation, upload_status, created_at, updated_at
​
sort_direction
string
default:"desc"
Direção da ordenação. Opções: asc, desc
​
date_from
string
Filtrar arquivos criados a partir desta data (formato ISO 8601)
​
date_to
string
Filtrar arquivos criados até esta data (formato ISO 8601)
​
created_at_start
string
Filtrar arquivos criados a partir deste timestamp (formato ISO 8601)
​
created_at_end
string
Filtrar arquivos criados até este timestamp (formato ISO 8601)
​
storage_path
string
Filtrar por caminho de armazenamento (correspondência parcial)
​
schema_version
string
Filtrar por versão do schema (correspondência parcial)
​
file_name
string
Filtrar por nome do arquivo (correspondência parcial)
​
validation
string
Filtrar por status de validação. Opções: valid, invalid, pending
​
upload_status
string
Filtrar por status de upload. Opções: completed, pending, failed

​
Resposta

​
data
array
Array de objetos de arquivo
​
meta
object
Metadados de paginação
​
success
boolean
Sempre true para requisições bem-sucedidas
curl -X GET \
  "https://api.datasnap.cloud/api/v1/schemas/meu-schema/files?per_page=15&page=1&sort_by=created_at&sort_direction=desc" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": 123,
      "file_name": "dados_vendas.jsonl",
      "size_bytes": 2048576,
      "schema_version": "1.0.0",
      "storage_path": "/uploads/2024/08/dados_vendas.jsonl",
      "validation": "valid",
      "upload_status": "completed",
      "created_at": "2024-08-15T10:30:00Z",
      "updated_at": "2024-08-15T10:35:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 15,
    "to": 15,
    "total": 73
  },
  "success": true
}

​
Códigos de Erro

​
200
Success
Lista de arquivos recuperada com sucesso
​
401
Error
Não autorizado - Token de autenticação inválido ou ausente
​
404
Error
Schema não encontrado

​
Exemplos de Uso

​
Listagem Básica de Arquivos

GET /api/v1/schemas/meu-schema/files

​
Buscar Arquivos Específicos

GET /api/v1/schemas/meu-schema/files?search=dados.jsonl&validation=valid

​
Filtrar por Intervalo de Datas

GET /api/v1/schemas/meu-schema/files?date_from=2024-01-01T00:00:00Z&date_to=2024-12-31T23:59:59Z

​
Ordenar por Tamanho do Arquivo

GET /api/v1/schemas/meu-schema/files?sort_by=size_bytes&sort_direction=desc