Arayış · Fayllar

Faylların siyahısı

GET /v1/files

İstifadəçinin faylları görə bildiyi şirkətlərin fayllarını ən yenidən ən köhnəyə doğru siyahıya alır.

Səhifələrə bölünmüş cavab: elementlər data daxilində, səhifə məlumatları isə meta daxilində gəlir. Səhifələmə və filtrlər

Parametrlər

Ad	Növ	Təsvir
`organization`	`string`	Yalnız həmin şirkətin elementlərini qaytarmaq üçün şirkətin uid identifikatoru (bax: `/organizations`).
`q`	`string`	Adın bir hissəsi, ən çoxu 100 simvol.
`type`	`string`	Faylın növü, məsələn, `image` və ya `video`.
`archived`	`integer`	Yalnız arxivləşdirilmiş fayllar üçün `1`, yalnız arxivləşdirilməmiş fayllar üçün `0`. Parametr olmadıqda bütün fayllar qaytarılır.
`page`	`integer`	Səhifə nömrəsi, 1-dən başlayır. Standart: 1.
`per_page`	`integer`	Səhifədəki element sayı, 1 ilə 100 arasında. Standart: 50.

Hər elementin sahələri

uid string: Fayl identifikatoru.
name string: Faylın idarəetmə panelindəki adı.
type string: Faylın növü, məsələn, image və ya video.
duration integer: Müddət, saniyə ilə.
archived boolean: Fayl arxivləşdirilibsə, true.
organization object: Faylın şirkəti: uid və name.

Mümkün xətalar

400 invalid_parameter Parametrin dəyəri yanlışdır, məsələn, per_page maksimumdan böyükdür.
404 organization_not_found Göstərilən organization istifadəçinin bu növ elementləri görə bildiyi şirkətə aid deyil.
Açar və limit xətaları bütün endpointlərə aiddir. Bütün xətalara bax

SorğucURLPHPJavaScript

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

Cavab200

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