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"
const response = await fetch(
'https://api.datasnap.cloud/api/v1/schemas/meu-schema/files?per_page=15&page=1',
{
method: 'GET',
headers: {
'Authorization': 'Bearer SEU_TOKEN_AQUI',
'Content-Type': 'application/json'
}
}
);
const data = await response.json();
import requests
url = "https://api.datasnap.cloud/api/v1/schemas/meu-schema/files"
headers = {
"Authorization": "Bearer SEU_TOKEN_AQUI",
"Content-Type": "application/json"
}
params = {
"per_page": 15,
"page": 1,
"sort_by": "created_at",
"sort_direction": "desc"
}
response = requests.get(url, headers=headers, params=params)
data = response.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
}
{
"errors": {
"schema": ["O esquema solicitado não foi encontrado."]
}
}
{
"error": "Não autenticado."
}
Endpoints
Listar Arquivos do Schema
Recuperar uma lista paginada de arquivos enviados para um schema específico com capacidades de filtragem e ordenação.
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"
const response = await fetch(
'https://api.datasnap.cloud/api/v1/schemas/meu-schema/files?per_page=15&page=1',
{
method: 'GET',
headers: {
'Authorization': 'Bearer SEU_TOKEN_AQUI',
'Content-Type': 'application/json'
}
}
);
const data = await response.json();
import requests
url = "https://api.datasnap.cloud/api/v1/schemas/meu-schema/files"
headers = {
"Authorization": "Bearer SEU_TOKEN_AQUI",
"Content-Type": "application/json"
}
params = {
"per_page": 15,
"page": 1,
"sort_by": "created_at",
"sort_direction": "desc"
}
response = requests.get(url, headers=headers, params=params)
data = response.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
}
{
"errors": {
"schema": ["O esquema solicitado não foi encontrado."]
}
}
{
"error": "Não autenticado."
}
Autenticação
Este endpoint requer autenticação. Inclua seu token Bearer no cabeçalho Authorization.
Authorization: Bearer SEU_TOKEN_AQUI
Parâmetros de Caminho
string
required
O slug do schema
Parâmetros de Consulta
integer
default:"15"
Número de itens por página (1-100)
integer
default:"1"
Número da página (mínimo: 1)
string
Termo de busca para filtrar arquivos por nome, caminho ou status de upload
string
default:"created_at"
Campo para ordenação. Opções:
file_name, size_bytes, schema_version, storage_path, validation, upload_status, created_at, updated_atstring
default:"desc"
Direção da ordenação. Opções:
asc, descstring
Filtrar arquivos criados a partir desta data (formato ISO 8601)
string
Filtrar arquivos criados até esta data (formato ISO 8601)
string
Filtrar arquivos criados a partir deste timestamp (formato ISO 8601)
string
Filtrar arquivos criados até este timestamp (formato ISO 8601)
string
Filtrar por caminho de armazenamento (correspondência parcial)
string
Filtrar por versão do schema (correspondência parcial)
string
Filtrar por nome do arquivo (correspondência parcial)
string
Filtrar por status de validação. Opções:
valid, invalid, pendingstring
Filtrar por status de upload. Opções:
completed, pending, failedResposta
array
Array de objetos de arquivo
Show Propriedades do Objeto Arquivo
Show Propriedades do Objeto Arquivo
integer
Identificador único do arquivo
string
Nome original do arquivo enviado
integer
Tamanho do arquivo em bytes
string
Versão do schema quando o arquivo foi enviado
string
Caminho onde o arquivo está armazenado
string
Status de validação do arquivo (
valid, invalid, pending)string
Status de upload do arquivo (
completed, pending, failed)string
Quando o arquivo foi criado (formato ISO 8601)
string
Quando o arquivo foi atualizado pela última vez (formato ISO 8601)
object
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"
const response = await fetch(
'https://api.datasnap.cloud/api/v1/schemas/meu-schema/files?per_page=15&page=1',
{
method: 'GET',
headers: {
'Authorization': 'Bearer SEU_TOKEN_AQUI',
'Content-Type': 'application/json'
}
}
);
const data = await response.json();
import requests
url = "https://api.datasnap.cloud/api/v1/schemas/meu-schema/files"
headers = {
"Authorization": "Bearer SEU_TOKEN_AQUI",
"Content-Type": "application/json"
}
params = {
"per_page": 15,
"page": 1,
"sort_by": "created_at",
"sort_direction": "desc"
}
response = requests.get(url, headers=headers, params=params)
data = response.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
}
{
"errors": {
"schema": ["O esquema solicitado não foi encontrado."]
}
}
{
"error": "Não autenticado."
}
Códigos de Erro
Success
Lista de arquivos recuperada com sucesso
Error
Não autorizado - Token de autenticação inválido ou ausente
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

