Referens · Filer

Lista filer

GET /v1/files

Listar filerna i de organisationer där användaren kan se filer, från nyaste till äldsta.

Sidindelat svar: objekten kommer i data och sidinformationen i meta. Sidindelning och filter

Parametrar

Namn	Typ	Beskrivning
`organization`	`string`	uid för en organisation, för att bara få dess objekt (se `/organizations`).
`q`	`string`	Del av namnet, högst 100 tecken.
`type`	`string`	Filtyp, till exempel `image` eller `video`.
`archived`	`integer`	`1` för bara arkiverade eller `0` för bara icke arkiverade filer. Utan parametern returneras alla filer.
`page`	`integer`	Sida, från 1. Standard: 1.
`per_page`	`integer`	Objekt per sida, från 1 till 100. Standard: 50.

Fält för varje objekt

uid string: Filens id.
name string: Filens namn i kontrollpanelen.
type string: Filtyp, till exempel image eller video.
duration integer: Längd i sekunder.
archived boolean: true om filen är arkiverad.
organization object: Filens organisation: uid och name.

Möjliga fel

400 invalid_parameter En parameter har ett ogiltigt värde, till exempel per_page över maxvärdet.
404 organization_not_found Angiven organization är inte en organisation där användaren kan se den här typen av objekt.
Fel som rör nyckeln och anropsgränsen gäller för alla endpoints. Visa alla fel

AnropcURLPHPJavaScript

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

Svar200

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