Referencia · Fájlok

Fájlok listázása

GET /v1/files

A legújabbtól a legrégebbiig listázza azoknak a szervezeteknek a fájljait, amelyekben a felhasználó láthatja a fájlokat.

Lapozott válasz: az elemek a data, a lap adatai a meta mezőben érkeznek. Lapozás és szűrők

Paraméterek

Név	Típus	Leírás
`organization`	`string`	Egy szervezet uid azonosítója, ha csak annak elemeit szeretné lekérni (lásd: `/organizations`).
`q`	`string`	A név egy része, legfeljebb 100 karakter.
`type`	`string`	A fájl típusa, például `image` vagy `video`.
`archived`	`integer`	`1`: csak az archivált fájlok, `0`: csak a nem archivált fájlok. A paraméter nélkül az összes fájl megjelenik.
`page`	`integer`	Oldalszám, 1-től kezdve. Alapértelmezés: 1.
`per_page`	`integer`	Elemek száma oldalanként, 1 és 100 között. Alapértelmezés: 50.

Az egyes elemek mezői

uid string: A fájl azonosítója.
name string: A fájl neve a vezérlőpulton.
type string: A fájl típusa, például image vagy video.
duration integer: Időtartam másodpercben.
archived boolean: true, ha a fájl archivált.
organization object: A fájl szervezete: uid és name.

Lehetséges hibák

400 invalid_parameter Egy paraméter értéke érvénytelen, például a per_page meghaladja a maximumot.
404 organization_not_found A megadott organization nem olyan szervezet, amelyben a felhasználó láthatja az ilyen típusú elemeket.
A kulccsal és a kéréskorláttal kapcsolatos hibák minden végpontra vonatkoznak. Az összes hiba megtekintése

KéréscURLPHPJavaScript

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

Válasz200

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