Sestavování URL

Struktura URL pro ABRA Flexi se skládá z několika částí

Ota Rádl avatar
Autor: Ota Rádl
Aktualizováno před více než týdnem
/c/<identifikátor firmy>/<evidence>/<ID záznamu>.<výstupní formát>
  • <identifikátor firmy>: jednoznačná identifikace firmy

  • <evidence>: typ evidence (adresář, objednávka, faktura, …), kompletní seznam zde, případně přímo ve Vašem webovém rozhraní vyhledejte Evidence list.

  • <výstupní formát>: výstupní formát (XML, JSON, …). Pokud není uvedeno zohledňuje se hlavička Accept, případně je vrácena HTML forma.

Výpis evidence

Pokud chcete výpis položek evidence (viz výpis), neuvádějte žádný identifikátor záznamu:

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

Je také možné použít filtraci:

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

Sumace záznamů

Pokud potřebujete získat základní sumace o dané evidenci, použijte sumaci:

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

Je také možné kombinovat filtraci a sumaci:

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

Přehled atributů

Pro každou evidenci je možné získat seznam atributů, které tato evidence podporuje. Tento přehled zohledňuje přístupová práva a licencování.

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

Přehled tiskových reportů

U evidence si můžete zobrazit seznam podporovaných reportů pro tisk do PDF:

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

Přehled podevidencí

Každá evidence může mít podevidenci (relaci). Příkladem může být položka faktury nebo kontakty u adresáře. Tyto záznamy jsou obvykle přístupné i přímo jako evidence. Rozdíl je v tom, že podevidence je filtrována danou relací. Přehled podevidencí lze získat takto:

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

S podevidencemi lze pak pracovat stejně jako s evidencí:

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

Pokud chcete při exportu z ABRA Flexi exportovat se záznamem i jeho podevidence, použijte parametr ?relations=vazby,prilohy,bankovniSpojeni.

Všechny podporované parametry

ABRA Flexi podporuje mnoho atributů a na této stránce je jejich popis.

?dry-run=true

?fail-on-warning=true

Pokud nastane varování, neukládej záznam (Validace dat)

?report-name=faktura

Jméno tiskového výstupu při exportu do PDF

?report-lang=en

Jazyk, ve kterém se má vygenerovat tiskový výstup při exportu do PDF

?report-sign=true

Zda se má PDF vyexportovat elektronicky podepsané

?detail=summary

?mode=ruby

?limit=100

?start=10

?order=nazev@A

?sort=nazev&dir=desc

Řazení záznamů pro ExtJS

?add-row-count=true

Přidání celkového počtu záznamů do výstupu (Stránkování)

?relations=vazby

Doplnění dat z relace (viz úrovně detailu) Přehled relací lze získat pro každou evidenci (/relations).

?includes=faktura-vydana/stredisko

Zahrnutí souvisejícího objektu úrovně detailu

?use-ext-id=ESHOP,MUJ

Pokud objekt obsahuje externí ID typu ESHOP nebo MUJ, používej jej jako vazební.

?use-internal-id=true

Kromě atributů ref a showAs u objektů dodá i atribut internalId, který obsahuje vnitřní ID záznamu

?stitky-as-ids=true

Štítky se budou exportovat i importovat ne jako seznam kódů, ale jako seznam číselných ID

?only-ext-ids=true

Primární klíč se nebude exportovat, elementy <id> budou obsahovat pouze externí ID. Podobné no-ids, ale ovlivňuje i podevidence.

?no-ext-ids=true

Odpověď nebude obsahovat externí identifikátory (optimalizace výkonu)

?no-ids=true

Odpověď nebude obsahovat žádné primární identifikátory (optimalizace výkonu). Ovlivňuje pouze hlavní evidenci.

?code-as-id=true

Pokud má objekt unikátní kód, vyexportuje se (kromě elementu <kod>) i jako <id>code:...</id>

?no-http-errors=true

Pokud nastane při zpracování požadavku chyba typu 4xx, server stejně pošle 200 OK

?nastaveni=true

Exportuj na začátku i jeden extra záznam s aktuálním nastavením

?as-gui=true

Zapne funkce, které doplní výstupy pro zpracování GUI

?code-in-response=true

V odpovědi bude u každého objektu nejen ID a URL, ale i kód.

?add-global-version=true

Odpověď bude obsahovat číslo globální verze aktuální při provádění exportu.

?encoding=iso-8859-2

Určuje kódování vstupního/výstupního souboru ve formátu CSV.

?delimeter=;

Určuje oddělovač vstupního/výstupního souboru ve formátu CSV.

?format=awis

Na výstupní XML bude aplikována jedna ze zakompilovaných XSL transformací (zde awis).

?auth=http

Vynutí přihlášení pomocí HTTP autentizace, čímž lze změnit například výchozí způsob přihlašování ve WUI.

?auth=html

Vynutí autentizaci pomocí HTML formuláře. To může být užitečné k potlačení automatické SSO autentizace.

?skupina-stitku=SKUPINA1,SKUPINA2

Umožní seskupení štítků při exportu dle skupiny (více štítky).

?mode=simple

Export dat nebude obsahovat další atributy (např. showAs, ref apod.).

Dostali jste odpověď na svou otázku?