ABRA API Tutoriál - Základní dotazování

Načteme si konkrétní objednávku přijatou s ID="1000000101" (objednávka s tímto ID je v demodatech obsažena). Načítáme, tj. zvolíme metodu GET a zadáme následující URL obsahující tentokrát i ID požadovaného objektu:

GET http://localhost:8082/data/receivedorders/1100000101

Pokud bylo vše správně zadáno, obdržíme po odeslání odpověď dle následujícího obrázku:

Vytvoříme si objednávku přijatou, na jejímž základě si později vytvoříme fakturu vydanou. Tvoříme nový objekt, tj. zvolíme metodu POST. Budeme ji směřovat na kolekci objednávek přijatých, čili URL adresa bude následující:

POST http://localhost:8082/data/receivedorders

V jednom kroku je možné rovnou zakládat i vlastněné kolekce (v našem případě řádky OP). Data nové OP zapsaná v JSON formátu nechť vypadají následovně:

{
	"docqueue_id": "I700000101",
	"period_id": "2K00000101",
	"docdate$date": "2021-09-09",
	"rows": [
	{
		"rowtype": 1,
		"text": "Položka #1",
		"totalprice": 123.4,
		"vatrate_id": "02100X0000",
		"division_id": "2100000101"
	},
	{
		"rowtype": 3,
		"store_id": "2100000101",
		"storecard_id": "3100000101",
		"unitquantity": 2,
		"qunit": "ks",
		"unitprice": 500,
		"vatrate_id": "02100X0000",
		"division_id": "2100000101"
	}
  ]
}

V aplikaci Postman se přepneme na záložku Body, zvolíme formát Raw / JSON dle obrázku, vložíme výše uvedená data OP a odešleme:

Po úspěšném vytvoření Web API vrátí status 201 Created a rovnou také kompletní reprezentaci vytvořeného objektu. Viz obrázek:

V předchozím bodu jsme si vytvořili OP. Nyní si předvedeme, jak lze tuto OP přes Web API zaktualizovat. Aktualizujeme, čili zvolíme metodu PUT. Musíme samozřejmě cílit na konkrétní OP, která má být aktualizována, čili URL adresa bude obsahovat ID nově vytvořené OP, viz výše:

PUT http://localhost:8082/data/receivedorders/1540000101

Předvedeme si přidání description. V datech stačí uvést jen to, co chceme na Business objektu změnit:

{
	"description": "abcde",
}

Data zadáme a odešleme stejně jako v předchozím případě při zakládání nové OP. Po úspěšné modifikaci rozhraní Web API opět vrátí status 200 OK a rovnou opět kompletní reprezentaci zmodifikovaného objektu.

Kromě jednoduchých aktualizací vlastností BO je možné aktualizovat vnořené kolekce. Předvedeme si přidání dalšího řádku do naší OP (data opět zadáme stejně jako v předchozím případě). Data pro update OP v JSON reprezentaci:

{
	"rows": [
	{
		"rowtype": 1,
		"text": "Item #3",
		"totalprice": 1234.55,
		"vatrate_id": "02100X0000",
		"division_id": "2100000101"
	}
 ]
}

Pokud bylo vše správně zadáno, obdržíte opět zmodifikovaný objekt OP již vč. nového řádku.

{
  "rows": [
	{"ID": "...."

U vlastněných kolekcí (např. řádky dokladů) je možné tyto kolekce procházet opět pomocí odpovídajícího zdroje. Takže pokud bychom např. chtěli vidět řádky naší OP, zadáme metodu GET a URL s uvedením zdroje pro řádky, příp. vč. ID konkrétního řádku:

GET http://localhost:8082/data/receivedorders/1540000101/rows

Příp. vč. ID konkrétního řádku (které zjistíme v předchozím dotazu - vaše bude odlišné):

GET http://localhost:81/data/receivedorders/1540000101/rows/1A50000101

Takto bychom mohli řádek i smazat, tj. zvolíme metodu DELETE a uvedeme URL směřující na konkrétní řádek, jak je uvedeno výše.

V předchozím bodě jsme si vytvořili novou OP. Nyní použijeme importního manažera pro vytvoření nového dokladu Dodací listy(DL) z naší OP. Příklad importu OP do dokladu Dodací listy v rámci Importního manažera je k dispozici zde.

V předchozím bodě jsme si vytvořili DL podle OP. Nyní si v ABRA Gen vytvoříme běžným způsobem FV a použijeme podruhé importního manažera pro import DL do této faktury. Tento příklad máme popsaný v rámci popisu importního manažera zde.

Nyní si předvedeme příklad jiného druhu a to, jak pracovat s číselníky, které podporují skrývání. V tomto případě je třeba do URL za název zdroje uvést views/hidden, pokud chceme jen skryté záznamy, nebo views/all, pokud chceme všechny záznamy vč. skrytých. Další práce se stejná, jako při dotazování jiných BO.

Dále viz podrobný help. Kap.: Struktura URI.

Nechť chceme načíst skrytá střediska. Načítáme, tj. zvolíme metodu GET a zadáme následující URL:

GET http://localhost:8082/data/divisions/views/hidden

Pokud bylo vše správně zadáno, obdržíme po odeslání odpověď dle následujícího obrázku:

GET http://localhost:8082/data/divisions/views/all

GET http://localhost:8082/data/divisions

Nyní si předvedeme příklad jiného druhu a to, jak volat QuickReports výrazy (QuickReports funkce). V tomto případě je třeba do URL uvést název zdroje určeného pro volání QR funkcí a to qrexpr a je třeba použít metodu POST. Výraz se uvádí v JSON řetězci, který je hodnotou vlastnosti expr vstupního JSON objektu. Nechť chceme načíst např. název firmy, jejíž ID známe.

Dále viz podrobný help. Kap.: Struktura URI.

URL bude vypadat následovně:

POST http://localhost:8082/data/qrexpr

Vlastní výraz zapsaný v JSON formátu bude následující:

{
  "expr": "NxGetValueFromRoll('Firms','Name','1100000101')"
}

V aplikaci Postman se přepneme na záložku Body (zde by měl být nastaveno formát Raw a JSON dle obrázku z předchozích příkladů), vložíme výše uvedený výraz a odešleme:

Po úspěšném zpracování Web API vrátí status 200 OK a rovnou také výsledek volané QR funkce. Viz obrázek: