Riferimento · File

Elenca i file

GET /v1/files

Elenca i file delle organizzazioni in cui l'utente può vedere i file, dal più recente al meno recente.

Risposta paginata: gli elementi arrivano in data e le informazioni sulla pagina in meta. Paginazione e filtri

Parametri

Nome	Tipo	Descrizione
`organization`	`string`	uid di un'organizzazione, per restituire solo i suoi elementi (vedi `/organizations`).
`q`	`string`	Parte del nome, fino a 100 caratteri.
`type`	`string`	Tipo di file, ad esempio `image` o `video`.
`archived`	`integer`	`1` per i soli file archiviati o `0` per i soli file non archiviati. Senza il parametro, vengono restituiti tutti.
`page`	`integer`	Pagina, a partire da 1. Predefinito: 1.
`per_page`	`integer`	Elementi per pagina, da 1 a 100. Predefinito: 50.

Campi di ogni elemento

uid string: Identificativo del file.
name string: Nome del file nel pannello di controllo.
type string: Tipo di file, ad esempio image o video.
duration integer: Durata, in secondi.
archived boolean: true se il file è archiviato.
organization object: Organizzazione del file: uid e name.

Errori possibili

400 invalid_parameter Un parametro ha un valore non valido, ad esempio per_page oltre il massimo.
404 organization_not_found Il valore di organization indicato non corrisponde a un'organizzazione in cui l'utente può vedere questo tipo di elemento.
Gli errori relativi alla chiave e al limite valgono per tutti gli endpoint. Vedi tutti gli errori

RichiestacURLPHPJavaScript

curl "https://api.on-cloud.live/v1/files?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/files?per_page=2');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/files?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

Risposta200

{
  "data": [
    {
      "uid": "c20ad4d76fe97759aa27a0c99bff6710",
      "name": "Horário de funcionamento",
      "type": "image",
      "duration": 8,
      "archived": false,
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      }
    },
    {
      "uid": "6512bd43d9caa6e02c990b0a82652dca",
      "name": "Cardápio do dia",
      "type": "image",
      "duration": 10,
      "archived": false,
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}