सन्दर्भ · फाइलहरू

फाइलहरूको सूची

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