Анықтамалық · Файлдар

Файлдарды тізімдеу

GET /v1/files

Пайдаланушы файлдарды көре алатын ұйымдардағы файлдарды ең жаңасынан ең ескісіне қарай тізімдейді.

Беттерге бөлінген жауап: элементтер data ішінде, ал бет туралы мәліметтер meta ішінде келеді. Беттеу және сүзгілер

Параметрлер

Атауы	Түрі	Сипаттамасы
`organization`	`string`	Тек сол ұйымның элементтерін алу үшін ұйымның uid идентификаторы (`/organizations` қараңыз).
`q`	`string`	Атаудың бір бөлігі, ең көбі 100 таңба.
`type`	`string`	Файл түрі, мысалы, `image` немесе `video`.
`archived`	`integer`	Тек мұрағатталғандар үшін `1`, тек мұрағатталмағандар үшін `0`. Параметр берілмесе, барлығы қайтарылады.
`page`	`integer`	Бет нөмірі, 1-ден басталады. Әдепкі: 1.
`per_page`	`integer`	Бір беттегі элементтер саны, 1–100 аралығында. Әдепкі: 50.

Әр элементтің өрістері

uid string: Файл идентификаторы.
name string: Файлдың басқару панеліндегі атауы.
type string: Файл түрі, мысалы, image немесе video.
duration integer: Ұзақтығы, секундпен.
archived boolean: Файл мұрағатталған болса, true.
organization object: Файлдың ұйымы: uid және name.

Болуы мүмкін қателер

400 invalid_parameter Параметрдің мәні жарамсыз, мысалы, per_page ең жоғарғы мәннен асады.
404 organization_not_found Көрсетілген organization пайдаланушы осы түрдегі элементтерді көре алатын ұйымға жатпайды.
Кілт пен шектеу қателері барлық эндпоинттерге қатысты. Барлық қателерді көру

Сұраныс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();

Жауап200

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