TempFile

A TempFile entitás dokumentációja.

2022.01.12 — Posted by Webb & Flow


A TempFile-ok NEM standard entitások.

Tempfile létrehozása

POST /projects/PROJECTID/tempFiles

{
   "name":"example.jpg",
   "chunks":3,
   "size":500000
}
  • name
    • a fájl eredeti neve
  • chunks
    • a szeletek száma
    • úgy érdemes megválasztani, hogy 1 szelet 200kb alatt legyen, de lehetőleg 10-15 szeletnél többől ne álljon egy fájl
  • size
    • a fájl eredeti mérete byte-ban

A válasz:

{
   "id":"1234567890123456",
   "createdAt":"2021-01-01T00:00:00+00:00",
   "createdBy":"gergely.kovacs@webbandflow.co.uk",
   "name":"example.jpg",
   "chunks":3,
   "size":500000
}

A visszaadott id mező alapján lehet feltölteni a szeleteket, illetve erre a fájlra hivatkozni a File bejegyzésben.

TempFile szelet feltöltése

PATCH /projects/PROJECTID/tempFiles/TEMPFILEID

{
   "chunk":0,
   "data":"ABCDEF..."
}
  • chunk
    • hanyadik szeletről van szó (0-tól indítva a számlálást)
  • data
    • a fájl base64 tartalmának egy része
    • fontos, hogy nem az eredeti tartalmat kell szétvágni, és azt elkódolni Base64-be, hanem az egész tartalmat kell Base64-be kódolni és utána azt felszeletelni

A válasz:

{
   "id":"1234567890123456",
   "dataSize":6
}
  • id
    • a fájl azonosítója (ami az url-ben is szerepel)
  • dataSize
    • a "data" mező-ben fogadott Base64 string hossza

TempFile törlés

A TempFile-okat nem lehet közvetlenül törölni.

A rendszer automatikusan törli, ha:

  • sikeresen be lett hivatkozva egy File entitásban
  • letelt a felhasználhatósági idő, ez tipikusan 7 nap körül van