Referans · Dosyalar

Dosyaları listele

GET /v1/files

Kullanıcının dosyaları görebildiği kuruluşlardaki dosyaları en yeniden en eskiye doğru listeler.

Sayfalanmış yanıt: öğeler data içinde, sayfa bilgileri ise meta içinde gelir. Sayfalama ve filtreler

Parametreler

Ad	Tür	Açıklama
`organization`	`string`	Yalnızca o kuruluşun öğelerini getirmek için bir kuruluşun uid değeri (bkz. `/organizations`).
`q`	`string`	Adın bir kısmı, en fazla 100 karakter.
`type`	`string`	Dosya türü, ör. `image` veya `video`.
`archived`	`integer`	Yalnızca arşivlenmiş dosyalar için `1`, yalnızca arşivlenmemiş dosyalar için `0`. Parametre verilmezse tüm dosyalar gelir.
`page`	`integer`	Sayfa numarası, 1'den başlar. Varsayılan: 1.
`per_page`	`integer`	Sayfa başına öğe sayısı, 1 ile 100 arasında. Varsayılan: 50.

Her öğenin alanları

uid string: Dosya tanımlayıcısı.
name string: Dosyanın kontrol panelindeki adı.
type string: Dosya türü, ör. image veya video.
duration integer: Süre, saniye cinsinden.
archived boolean: Dosya arşivlenmişse true.
organization object: Dosyanın kuruluşu: uid ve name.

Olası hatalar

400 invalid_parameter Bir parametrenin değeri geçersiz, ör. per_page izin verilen en yüksek değerin üzerinde.
404 organization_not_found Belirtilen organization, kullanıcının bu tür öğeleri görebildiği bir kuruluşa ait değil.
Anahtar ve limit hataları tüm uç noktalar için geçerlidir. Tüm hataları görün

İstekcURLPHPJavaScript

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

Yanıt200

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