Marejeleo · Faili

Orodhesha faili

GET /v1/files

Huorodhesha faili za mashirika ambamo mtumiaji anaweza kuona faili, kuanzia mpya zaidi hadi za zamani zaidi.

Jibu lenye kurasa: vipengee huja ndani ya data na maelezo ya ukurasa ndani ya meta. Kurasa na vichujio

Vigezo

Jina	Aina	Maelezo
`organization`	`string`	uid ya shirika, ili kuleta vipengee vyake pekee (tazama `/organizations`).
`q`	`string`	Sehemu ya jina, hadi herufi 100.
`type`	`string`	Aina ya faili, kama `image` au `video`.
`archived`	`integer`	`1` kwa faili zilizo kwenye kumbukumbu pekee au `0` kwa zisizo kwenye kumbukumbu pekee. Bila kigezo hiki, faili zote huletwa.
`page`	`integer`	Ukurasa, kuanzia 1. Chaguomsingi: 1.
`per_page`	`integer`	Vipengee kwa kila ukurasa, kuanzia 1 hadi 100. Chaguomsingi: 50.

Sehemu za kila kipengee

uid string: Kitambulisho cha faili.
name string: Jina la faili kwenye paneli ya udhibiti.
type string: Aina ya faili, kama image au video.
duration integer: Muda, kwa sekunde.
archived boolean: true ikiwa faili iko kwenye kumbukumbu.
organization object: Shirika la faili: uid na name.

Hitilafu zinazowezekana

400 invalid_parameter Kigezo kina thamani batili, kama per_page inayozidi kiwango cha juu.
404 organization_not_found organization uliyotoa si shirika ambamo mtumiaji anaweza kuona aina hii ya kipengee.
Hitilafu za ufunguo na za kikomo zinahusu endpoint zote. Tazama hitilafu zote

OmbicURLPHPJavaScript

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

Jibu200

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