Лавлах · Файлууд

Файлуудыг жагсаах

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