संदर्भ · फ़ाइलें

फ़ाइलों की सूची

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