Prílohy

Ako pracovať s prílohami

Lenka Haringerová avatar
Written by Lenka Haringerová
Updated over a week ago

V prípade záznamov, ktoré podporujú prílohy, môžete zobraziť zoznam príloh takto:

/c/company/addresar/12/attachments

Metadáta jednej konkrétnej prílohy možno získať bežným spôsobom:

/c/spoločnost/adresat/12/prílohy/75

Binárne údaje prílohy možno získať pomocou funkcie GET, pričom súčasťou odpovede je správna hlavička Content-Type:

/c/company/addressar/12/attachments/75/content

Ak je prílohou obrázok, náhľad možno získať podobným spôsobom (ak neexistuje, odpoveďou bude chyba 404):

/c/company/addressar/12/attachments/75/thumbnail

Prílohu je možné vytvoriť aj prostredníctvom funkcie PUT, je potrebné zadať názov súboru a odoslať jeho typ v hlavičke Content-Type:

PUT /c/company/adresar/12/prilohy/new/ Content-Type: image/jpeg

Binárne údaje prílohy musia byť v tele požiadavky. Existujúcu prílohu nie je možné upraviť, v takom prípade je potrebné prílohu vymazať a znovu vytvoriť. Podrobnosti o importovaní príloh prostredníctvom XML nájdete nižšie.

Obsah prílohy je možné exportovať aj priamo do XML, údaje sa exportujú v kódovaní Base64(... ).

Prílohy možno exportovať aj ako súčasť objektov, ku ktorým patria, keď sa k nim pristupuje prostredníctvom rozhrania REST API, potom je potrebné do adresy URL uviesť parameter relations=attachments.

Podporovaný je aj import príloh prostredníctvom XML (údaje musia byť opäť zakódované v Base64), ale má to určité obmedzenia:

  • novú prílohu možno vytvoriť len ako súčasť iného objektu (nemôže byť koreňovým tagom)

  • je možné meniť iba metadáta, nie údaje v prílohe.

Podpora obrázkov

Ak do systému ABRA Flexi nahráte prílohu vo formáte obrázka, pribudla podpora generovania miniatúr. Obrázok musí byť v jednom z nasledujúcich formátov:

  • image/jpeg

  • obrázok/gif

  • obrázok/png

V prípade objektov s prílohou môžete požiadať o primárny obrázok (ak neexistuje, odpoveďou bude chyba 404):

/c/company/pricing/12/thumbnail.png

Pomocou parametrov w a h je možné určiť veľkosť obrázka.

Prílohy k nastaveniam

Nastavenie spoločnosti obsahuje dve prílohy: logo a podpis a pečiatku. Zaobchádza sa s nimi špeciálnym spôsobom.

Pomocou funkcie GET je možné zistiť, či je logo pripojené k nastaveniu:

GET /c/company/settings/1/logo

Ak je logo pripojené, vráti sa presmerovanie na kanonickú adresu URL prílohy (v tvare /c/company/attachment/3), t. j. kód 303 a hlavička Location. Ak logo nie je pripojené, vráti sa kód 404.

Ak logo nie je pripojené, možno ho pripojiť volaním PUT alebo POST (so správnou hlavičkou Content-Type):

PUT /c/company/settings/1/logo Content-Type: image/jpeg

Ako zvyčajne, binárne údaje loga musia byť v tele požiadavky. Podobne ako v prípade príloh, logo nemôžete pripojiť k nastaveniu, ak je už logo pripojené. V takejto situácii sa vráti chybový kód 400. Úspech je označený kódom 201 a hlavička Location obsahuje adresu URL novovytvorenej prílohy.

Logo môžete odstrániť pomocou príkazu DELETE:

DELETE /c/company/settings/1/logo

Ak bolo logo odstránené v poriadku, vráti sa kód 200. Ak logo neexistuje, vráti sa chybový kód 404.

S podpisom a pečiatkou sa zaobchádza úplne rovnako, len v adrese URL sa namiesto slova logo použije podpis-pečiatka (napr. /c/firm/settings/1/signature-stamp).

Did this answer your question?