Referenca · Datoteke

Pregled datotek

GET /v1/files

Vrne datoteke organizacij, v katerih lahko uporabnik vidi datoteke, od najnovejše do najstarejše.

Odgovor, razdeljen na strani: elementi so v data, podatki o strani pa v meta. Ostranjevanje in filtri

Parametri

Ime	Vrsta	Opis
`organization`	`string`	uid organizacije, če želite samo njene elemente (glejte `/organizations`).
`q`	`string`	Del imena, največ 100 znakov.
`type`	`string`	Vrsta datoteke, na primer `image` ali `video`.
`archived`	`integer`	`1` samo za arhivirane datoteke, `0` samo za nearhivirane. Brez parametra so vrnjene vse.
`page`	`integer`	Stran, od 1 naprej. Privzeto: 1.
`per_page`	`integer`	Število elementov na stran, od 1 do 100. Privzeto: 50.

Polja posameznega elementa

uid string: Identifikator datoteke.
name string: Ime datoteke na nadzorni plošči.
type string: Vrsta datoteke, na primer image ali video.
duration integer: Trajanje v sekundah.
archived boolean: true, če je datoteka arhivirana.
organization object: Organizacija datoteke: uid in name.

Možne napake

400 invalid_parameter Parameter ima neveljavno vrednost, na primer per_page nad največjo dovoljeno vrednostjo.
404 organization_not_found Podana vrednost organization ni organizacija, v kateri lahko uporabnik vidi to vrsto elementov.
Napake ključa in omejitve zahtev veljajo za vse končne točke. Prikaži vse napake

ZahtevacURLPHPJavaScript

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

Odgovor200

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