Референца · Датотеке

Списак датотека

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