Preskoči na glavno vsebino

Zostavovanie URL

Štruktúra URL pre ABRA Flexi sa skladá z niekoľkých častí

Avtor: Petr Pech
/c/<identifikátor firmy>/<evidence>/<ID záznamu>.<výstupní formát>
  • <identifikátor firmy>: jednoznačná identifikácia firmy

  • <evidencia>: typ evidencie (adresár, objednávka, faktúra, …), kompletný zoznam tu, prípadne priamo vo Vašom webovom rozhraní vyhľadajte Evidence list.

  • <výstupný formát>: výstupný formát (XML, JSON, …). Pokud nie je uvedený, zohľadňuje sa hlavička Accept, prípadne je vrátená HTML forma.

Výpis evidencie

Ak chcete výpis položiek evidencie (pozri výpis), neuvádzajte žiadny identifikátor záznamu:

/c/<identifikátor firmy>/<evidence>

Je tiež možné použiť filtrovanie:

/c/<identifikátor firmy>/<evidence>/(<filtr>)

Sumácia záznamov

Ak potrebujete získať základné sumácie o danej evidencii, použite sumáciu:

/c/<identifikátor firmy>/<evidence>/$sum

Je tiež možné kombinovať filtrovanie a sumáciu:

/c/<identifikátor firmy>/<evidence>/(<filtr>)/$sum

Prehľad atribútov

Pre každú evidenciu je možné získať zoznam atribútov, ktoré táto evidencia podporuje. Tento prehľad zohľadňuje prístupové práva a licencovanie.

/c/<identifikátor firmy>/<evidence>/properties

Prehľad tlačových reportov

Pri evidencii si môžete zobraziť zoznam podporovaných reportov pre tlač do PDF:

/c/<identifikátor firmy>/<evidence>/reports

Prehľad podevidencií

Každá evidencia môže mať podevidenciu (reláciu). Príkladom môže byť položka faktúry alebo kontakty v adresári. Tieto záznamy sú zvyčajne prístupné aj priamo ako evidencia. Rozdiel spočíva v tom, že podevidencia je filtrovaná danou reláciou. Prehľad podevidencií možno získať takto:

/c/<identifikátor firmy>/<evidence>/relations

S podevidenciami možno potom pracovať rovnako ako s evidenciou:

/c/<identifikátor firmy>/<evidence>/<ID záznamu>/<podevidence>

Ak chcete pri exporte z ABRA Flexi exportovať spolu so záznamom aj jeho podevidencie, použite parameter ?relations=vazby,prilohy,bankovniSpojeni.

Všetky podporované parametre

ABRA Flexi podporuje množstvo atribútov a na tejto stránke nájdete ich popis.

?dry-run=true

?fail-on-warning=true

Ak nastane varovanie, neukladaj záznam (Validácia dát)

?report-name=faktura

Názov tlačového výstupu pri exporte do PDF

?report-lang=en

Jazyk, v ktorom sa má vygenerovať tlačový výstup pri exporte do PDF

?report-sign=true

Či sa má PDF exportovať elektronicky podpísané

?detail=summary

Definícia úrovne detailu

?mode=ruby

?limit=100

?start=10

?order=nazev@A

?sort=nazev&dir=desc

Radenie záznamov pre ExtJS

?add-row-count=true

Pridanie celkového počtu záznamov do výstupu (Stránkovanie)

?relations=vazby

Doplnenie dát z relácie (pozri úrovne detailu) Prehľad relácií možno získať pre každú evidenciu (/relations).

?includes=faktura-vydana/stredisko

Zahrnutie súvisiaceho objektu úrovne detailu

?use-ext-id=ESHOP,MUJ

Ak objekt obsahuje externé ID typu ESHOP alebo MUJ, použije ho ako väzbové.

?use-internal-id=true

Okrem atribútov ref a showAs pri objektoch dodá aj atribút internalId, ktorý obsahuje vnútorné ID záznamu

?stitky-as-ids=true

Štítky sa budú exportovať aj importovať nie ako zoznam kódov, ale ako zoznam číselných ID

?only-ext-ids=true

Primárny kľúč sa nebude exportovať, elementy <id> budú obsahovať iba externé ID. Podobné ako no-ids, ale ovplyvňuje aj podevidencie.

?no-ext-ids=true

Odpoveď nebude obsahovať externé identifikátory (optimalizácia výkonu)

?no-ids=true

Odpoveď nebude obsahovať žiadne primárne identifikátory (optimalizácia výkonu). Ovplyvňuje iba hlavnú evidenciu.

?code-as-id=true

Ak má objekt unikátny kód, vyexportuje sa (okrem elementu <kod>) aj ako <id>code:...</id>

?no-http-errors=true

Ak pri spracovaní požiadavky nastane chyba typu 4xx, server napriek tomu odošle 200 OK

?nastaveni=true

Exportuj na začiatku aj jeden extra záznam s aktuálnym nastavením

?as-gui=true

Zapne funkcie, ktoré doplnia výstupy pre spracovanie GUI

?code-in-response=true

V odpovedi bude pri každom objekte nielen ID a URL, ale aj kód.

?add-global-version=true

Odpoveď bude obsahovať číslo globálnej verzie aktuálnej pri vykonávaní exportu.

?encoding=iso-8859-2

Určuje kódovanie vstupného/výstupného súboru vo formáte CSV.

?delimeter=;

Určuje oddeľovač vstupného/výstupného súboru vo formáte CSV.

?format=awis

Na výstupné XML bude aplikovaná jedna zo skompilovaných XSL transformácií (tu awis).

?auth=http

Vynúti prihlásenie pomocou HTTP autentifikácie, čím možno zmeniť napríklad predvolený spôsob prihlasovania vo WUI.

?auth=html

Vynúti autentifikáciu pomocou HTML formulára. To môže byť užitočné na potlačenie automatickej SSO autentifikácie.

?skupina-stitku=SKUPINA1,SKUPINA2

Umožní zoskupenie štítkov pri exporte podľa skupiny (viac štítky).

?mode=simple

Export dát nebude obsahovať ďalšie atribúty (napr. showAs, ref apod.).

?access-attribs=true

Vyplní atribúty editovateľnosti záznamu a kolekcií: editable označuje možnosť editácie, deletable označuje možnosť zmazania a insertable označuje možnosť pridávania do kolekcie.

?mode=xml_import_export

Špeciálny formát odpovede uľahčujúci prenosy dát. Odpoveď používa Hybridné identifikátory a v prípade potreby rozdeľuje export 1 záznamu na 2 elementy (napr. nastavenie referencie na hlavnú prílohu používateľského reportu).

Ste s tem dobili odgovor na svoje vprašanje?