Referanse · Filer

Hent filer

GET /v1/files

Viser filene i organisasjonene der brukeren kan se filer, fra nyeste til eldste.

Svar delt inn i sider: Elementene kommer i data og sideinformasjonen i meta. Sideinndeling og filtre

Parametere

Navn	Type	Beskrivelse
`organization`	`string`	uid for en organisasjon, slik at bare elementene i den returneres (se `/organizations`).
`q`	`string`	Del av navnet, opptil 100 tegn.
`type`	`string`	Filtype, for eksempel `image` eller `video`.
`archived`	`integer`	`1` for bare arkiverte eller `0` for bare ikke-arkiverte filer. Uten parameteren returneres alle filer.
`page`	`integer`	Side, fra og med 1. Standard: 1.
`per_page`	`integer`	Elementer per side, fra 1 til 100. Standard: 50.

Felter for hvert element

uid string: Filens ID.
name string: Filens navn i kontrollpanelet.
type string: Filtype, for eksempel image eller video.
duration integer: Varighet i sekunder.
archived boolean: true hvis filen er arkivert.
organization object: Filens organisasjon: uid og name.

Mulige feil

400 invalid_parameter En parameter har en ugyldig verdi, for eksempel per_page over maksimum.
404 organization_not_found Den oppgitte organization er ikke en organisasjon der brukeren kan se denne typen elementer.
Feil knyttet til nøkkel og grenser gjelder for alle endepunkter. Se alle feil

ForespørselcURLPHPJavaScript

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