Referenz · Dateien

Dateien auflisten

GET /v1/files

Listet die Dateien der Organisationen, in denen der Benutzer Dateien sehen kann, von der neuesten zur ältesten auf.

Paginierte Antwort: Die Elemente stehen in data, die Seiteninformationen in meta. Paginierung und Filter

Parameter

Name	Typ	Beschreibung
`organization`	`string`	uid einer Organisation, um nur deren Elemente zu erhalten (siehe `/organizations`).
`q`	`string`	Teil des Namens, bis zu 100 Zeichen.
`type`	`string`	Dateityp, z. B. `image` oder `video`.
`archived`	`integer`	`1` für nur archivierte oder `0` für nur nicht archivierte Dateien. Ohne den Parameter werden alle geliefert.
`page`	`integer`	Seite, beginnend bei 1. Standard: 1.
`per_page`	`integer`	Elemente pro Seite, von 1 bis 100. Standard: 50.

Felder jedes Elements

uid string: Kennung der Datei.
name string: Name der Datei im Kontrollzentrum.
type string: Dateityp, z. B. image oder video.
duration integer: Dauer in Sekunden.
archived boolean: true, wenn die Datei archiviert ist.
organization object: Organisation der Datei: uid und name.

Mögliche Fehler

400 invalid_parameter Ein Parameter hat einen ungültigen Wert, z. B. per_page über dem Maximum.
404 organization_not_found Der angegebene Wert für organization gehört zu keiner Organisation, in der der Benutzer diese Art von Elementen sehen kann.
Fehler zum Schlüssel und zum Anfragelimit gelten für alle Endpunkte. Alle Fehler ansehen

AnfragecURLPHPJavaScript

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

Antwort200

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