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

एक फ़ाइल देखें

GET /v1/files/{uid}

uid के आधार पर एक फ़ाइल दिखाता है, साथ में उसका आकार, रिज़ॉल्यूशन, मूल फ़ाइल का URL और वे प्लेलिस्ट जिनमें वह शामिल है।

पाथ पैरामीटर

नाम	प्रकार	विवरण
`uid`	`string`	फ़ाइल का uid।

रिस्पॉन्स के फ़ील्ड

uid string: फ़ाइल का पहचानकर्ता।
name string: कंट्रोल पैनल में फ़ाइल का नाम।
type string: फ़ाइल का प्रकार, जैसे image या video।
duration integer: अवधि, सेकंड में।
archived boolean: अगर फ़ाइल संग्रहीत है, तो true।
organization object: फ़ाइल का संगठन: uid और name।
size integer: मूल फ़ाइल का आकार, बाइट में।
width integer: मूल फ़ाइल की चौड़ाई, पिक्सेल में।
height integer: मूल फ़ाइल की ऊँचाई, पिक्सेल में।
aspect_ratio string: चौड़ाई और ऊँचाई का अनुपात, जैसे 1.78।
url string: मूल फ़ाइल का URL, या उपलब्ध न होने पर खाली टेक्स्ट।
scheduled boolean: अगर फ़ाइल की कोई सक्रिय शेड्यूलिंग है, तो true।
playlists array: वे प्लेलिस्ट जिनमें फ़ाइल शामिल है (uid, name और organization)। केवल वही प्लेलिस्ट दिखती हैं जिन्हें उपयोगकर्ता देख सकता है।

संभावित त्रुटियाँ

404 not_found एंडपॉइंट मौजूद नहीं है, या आइटम मौजूद नहीं है या ऐसे संगठन का है जिसे उपयोगकर्ता नहीं देख सकता।
कुंजी और सीमा से जुड़ी त्रुटियाँ सभी एंडपॉइंट पर लागू होती हैं। सभी त्रुटियाँ देखें

अनुरोधcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/files/a87ff679a2f3e71d9181a67b7542122c" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/files/a87ff679a2f3e71d9181a67b7542122c');
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/a87ff679a2f3e71d9181a67b7542122c', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

रिस्पॉन्स200

{
  "data": {
    "uid": "a87ff679a2f3e71d9181a67b7542122c",
    "name": "Promoção de verão",
    "type": "video",
    "duration": 30,
    "archived": false,
    "organization": {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro"
    },
    "size": 18734520,
    "width": 1920,
    "height": 1080,
    "aspect_ratio": "1.78",
    "url": "https://oncloud.bunny.files.on-cloud.live/files/a87ff679a2f3e71d9181a67b7542122c-1.mp4",
    "scheduled": true,
    "playlists": [
      {
        "uid": "e4da3b7fbbce2345d7772b0674a318d5",
        "name": "Lista principal",
        "organization": {
          "uid": "8f14e45fceea167a5a36dedd4bea2543",
          "name": "Loja Centro"
        }
      }
    ]
  }
}

आइटम मौजूद नहीं है या एक्सेस नहीं है404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}