Referință · Fișiere

Listarea fișierelor

GET /v1/files

Listează fișierele din organizațiile în care utilizatorul poate vedea fișiere, de la cele mai noi la cele mai vechi.

Răspuns paginat: elementele vin în data, iar informațiile despre pagină, în meta. Paginare și filtre

Parametri

Nume	Tip	Descriere
`organization`	`string`	uid-ul unei organizații, pentru a returna doar elementele acesteia (vedeți `/organizations`).
`q`	`string`	O parte din nume, de cel mult 100 de caractere.
`type`	`string`	Tipul fișierului, de exemplu `image` sau `video`.
`archived`	`integer`	`1` doar pentru fișierele arhivate sau `0` doar pentru cele nearhivate. Fără acest parametru, sunt returnate toate.
`page`	`integer`	Pagina, începând de la 1. Implicit: 1.
`per_page`	`integer`	Elemente pe pagină, de la 1 la 100. Implicit: 50.

Câmpurile fiecărui element

uid string: Identificatorul fișierului.
name string: Numele fișierului în panoul de control.
type string: Tipul fișierului, de exemplu image sau video.
duration integer: Durata, în secunde.
archived boolean: true dacă fișierul este arhivat.
organization object: Organizația fișierului: uid și name.

Erori posibile

400 invalid_parameter Un parametru are o valoare invalidă, de exemplu per_page peste valoarea maximă.
404 organization_not_found Valoarea organization indicată nu corespunde unei organizații în care utilizatorul poate vedea acest tip de element.
Erorile de cheie și de limită se aplică tuturor endpointurilor. Vedeți toate erorile

CererecURLPHPJavaScript

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();

Răspuns200

{
  "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
  }
}