Տեղեկատու · Ֆայլեր
Ֆայլերի ցանկ
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։ |
Յուրաքանչյուր տարրի դաշտերը
uidstring- Ֆայլի նույնացուցիչը։
namestring- Ֆայլի անունը կառավարման վահանակում։
typestring- Ֆայլի տեսակը, օրինակ՝
imageկամvideo։ durationinteger- Տևողությունը՝ վայրկյաններով։
archivedbooleantrue, եթե ֆայլն արխիվացված է։organizationobject- Ֆայլի կազմակերպությունը՝
uidևname։
Հնարավոր սխալներ
- 400
invalid_parameterՊարամետրերից մեկն ունի անվավեր արժեք, օրինակ՝per_pageպարամետրը գերազանցում է առավելագույնը։ - 404
organization_not_foundorganizationպարամետրում նշված կազմակերպությունը չկա այն կազմակերպությունների մեջ, որտեղ օգտատերը կարող է տեսնել այս տեսակի տարրեր։ - Բանալու և սահմանաչափի սխալները վերաբերում են բոլոր վերջնակետերին։ Տեսնել բոլոր սխալները
Հարցում
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
}
}