Referenca · Skedarët

Listo skedarët

GET /v1/files

Liston skedarët e organizatave ku përdoruesi mund të shohë skedarë, nga më të rinjtë te më të vjetrit.

Përgjigje e ndarë në faqe: elementet vijnë te data dhe informacioni i faqes te meta. Ndarja në faqe dhe filtrat

Parametrat

Emri	Lloji	Përshkrimi
`organization`	`string`	uid i një organizate, për të marrë vetëm elementet e saj (shihni `/organizations`).
`q`	`string`	Pjesë e emrit, deri në 100 karaktere.
`type`	`string`	Lloji i skedarit, si p.sh. `image` ose `video`.
`archived`	`integer`	`1` vetëm për skedarët e arkivuar ose `0` vetëm për skedarët e paarkivuar. Pa këtë parametër, vijnë të gjithë.
`page`	`integer`	Faqja, duke filluar nga 1. Parazgjedhja: 1.
`per_page`	`integer`	Elemente për faqe, nga 1 deri në 100. Parazgjedhja: 50.

Fushat e çdo elementi

uid string: Identifikuesi i skedarit.
name string: Emri i skedarit në panelin e kontrollit.
type string: Lloji i skedarit, si p.sh. image ose video.
duration integer: Kohëzgjatja, në sekonda.
archived boolean: true nëse skedari është i arkivuar.
organization object: Organizata e skedarit: uid dhe name.

Gabimet e mundshme

400 invalid_parameter Një parametër ka vlerë të pavlefshme, si p.sh. per_page mbi maksimumin.
404 organization_not_found organization i dhënë nuk është një organizatë ku përdoruesi mund ta shohë këtë lloj elementi.
Gabimet e çelësit dhe të kufirit vlejnë për të gjitha pikat fundore. Shiko të gjitha gabimet

KërkesacURLPHPJavaScript

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

Përgjigjja200

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