Viiteopas · Tiedostot

Listaa tiedostot

GET /v1/files

Listaa uusimmasta vanhimpaan tiedostot niistä organisaatioista, joissa käyttäjä voi nähdä tiedostot.

Sivutettu vastaus: kohteet palautetaan kentässä data ja sivun tiedot kentässä meta. Sivutus ja suodattimet

Parametrit

Nimi	Tyyppi	Kuvaus
`organization`	`string`	Organisaation uid, jos haluat vain sen kohteet (katso `/organizations`).
`q`	`string`	Osa nimestä, enintään 100 merkkiä.
`type`	`string`	Tiedostotyyppi, esimerkiksi `image` tai `video`.
`archived`	`integer`	`1` vain arkistoiduille tai `0` vain arkistoimattomille tiedostoille. Ilman parametria palautetaan kaikki.
`page`	`integer`	Sivunumero 1:stä alkaen. Oletus: 1.
`per_page`	`integer`	Kohteita sivulla, 1–100. Oletus: 50.

Kunkin kohteen kentät

uid string: Tiedoston tunniste.
name string: Tiedoston nimi ohjauspaneelissa.
type string: Tiedostotyyppi, esimerkiksi image tai video.
duration integer: Kesto sekunteina.
archived boolean: true, jos tiedosto on arkistoitu.
organization object: Tiedoston organisaatio: uid ja name.

Mahdolliset virheet

400 invalid_parameter Parametrilla on virheellinen arvo, esimerkiksi per_page on suurempi kuin enimmäisarvo.
404 organization_not_found Annettu organization ei ole organisaatio, jossa käyttäjä voi nähdä tämäntyyppisiä kohteita.
Avaimeen ja pyyntörajaan liittyvät virheet koskevat kaikkia päätepisteitä. Näytä kaikki virheet

PyyntöcURLPHPJavaScript

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

Vastaus200

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