Web API - Zpracování požadavků v mezipaměti

Povinná položka. Aktuálně může obsahovat tyto hodnoty:

• create - založí nový BO a vloží jej do mezipaměti

• load - načte existující BO a vloží jej do mezipaměti

• clone - naklonuje existující BO a vloží jej do mezipaměti

• update - pošle změnu na BO držený v mezipaměti

• save - uloží BO držený v mezipaměti do databáze a uvolní jej z mezipaměti

• discard - uvolní BO držený v mezipaměti z mezipaměti

  Příkaz discard umožňuje vyčistit buď specifickou keš, pokud je předán parametr cacheid, nebo všechny keše uživatele, pokud je zavolán bez parametrů. Tento příkaz slouží k uvolnění business objektů, včetně případného odemknutí pesimistického zámku. Při úspěšném provedení příkaz nevrací žádná data a vrací pouze stavový kód 204 (No Content).

• import - možnost volat importní managery. Více viz příklad č. 2.

• info - vrací pole informací cacheid, clsid, oid, objversion ze všech keší anebo jen za jednu keš, pokud je v těle zadáno cacheid.

  Výsledek zpracování dotazu:

  [
      {"cacheid":"xxx","clsid":"O3BDOKTWEFD13ACM03KIU0CLP4","oid":"1LS0000101","objversion":0},
      {"cacheid":"xxx","clsid":"O3BDOKTWEFD13ACM03KIU0CLP4","oid":"2LS0000101","objversion":0}
  ]

Pomocí tohoto objektu se posílají změny na BO. Je možné jej použít u typu operací create, load, clone, update, save. Pokud se použije v souvislosti s operací, která vkládá BO do mezipaměti (create, clone, load) a během aplikace změn dojde k chybě, BO se z mezipaměti opět odstraní. Položka není povinná.

Může se jednat o jeden objekt reprezentující změny BO ve stejném formátu, jako se posílá na běžné endpointy business objektů anebo pole těchto objektů. Pokud se jedná o pole, pak jsou změny aplikovány postupně (pokud dojde k chybě, aplikování se přeruší).

Tato položka umožňuje definovat metainformace, které mají být vráceny.

{
    	"cacheid": "xb1",
    	"type": "create",
    	"data": {
    		"object_data": {
    			"firm_id": "F011000000",
    			"docqueue_id": "5600000101",
    			"storedocqueue_id": "P600000101",
    			"rows": [
    				{
    					"@temporaryid": "ID1",
    					"rowtype": 0,
    					"text": "testovaci radek",
    					"division_id": "2100000101"
    				},
    				{
    					"@temporaryid": "ID2",
    					"rowtype": 3,
    					"store_id": "2100000101",
    					"storecard_id": "2100000101",
    					"unitquantity": 10,
    					"unitprice": 20.5,
    					"division_id": "2100000101"
    				}
    			]
    		},
    		"meta": {
    			"validation": {
    				"errors": True,
    				"warnings": True,
    				"objectdataerrors": True,
    				"queryerrors": True
			}
		}
	}
}

Položka Validation obsahuje tyto parametry:

• errors - Tento parametr řídí zachycení a vrácení výjimek typu 'error'. Pokud je nastaven na hodnotu true, systém identifikuje a explicitně vrátí všechny chybové stavy v rámci operace.
• warnings - Tento parametr řídí zachycení a vrácení výjimek typu 'warning'. Pokud je nastaven na hodnotu true, systém identifikuje a explicitně vrátí všechny varovné stavy, které mohou signalizovat potenciální problémy nebo potřebu zvýšené pozornosti uživatele.
• objectdataerrors - Tento parametr kontroluje zpracování výjimek vzniklých při setování dat do business objektů. Pokud je nastaven na hodnotu true, systém potlačí tyto výjimky, přičemž se zachytí a začlení do strukturovaného seznamu chyb, který se následně přidá do výstupu validačního procesu. Tímto způsobem umožňuje API pokračovat ve zpracování bez přerušení a poskytuje uživatelům detailní informace o chybách, které byly identifikovány během pokusů o úpravu dat objektů.
• queryerrors - Tento parametr umožňuje zachytávání výjimek vyvolaných při provádění dotazů na business objekty. Pokud je nastaven na hodnotu true, dochází k internímu potlačení výjimek a k akumulaci chyb v samostatném strukturním uzlu 'queryerrors' integrovaném do výstupního datového streamu validace. Pro každou položku, u které dojde k vyvolání výjimky, je v rámci výstupu dotazu přiřazena hodnota null ve formátu JSON.

Položka validation může být typu boolean nebo objekt. Pokud je typu boolen, nastaví se tato boolean hodnota na všechny podřízené parametry. Pokud je typu objekt, potom je možné specifikovat, které parametry chce uživatel vrátit.

{
	"cacheid": "xxx",
	"type": "create",
	"data": {
		"class": "issuedinvoices",
		"object_data": {
			"coef": 1,
			"bankaccount_id": "2200000101",
			"rows": [{"rowtype": 0, "text": "test", "division_id": "2200000101"}]
		},
		"query": {
			"select": [
				"id",
				"bankaccount_id",
				"bankaccount_id.name"]
		},
		"meta": {
			"validation": {
				"errors": True,
				"warnings": True,
				"objectdataerrors": True,
				"queryerrors": True
			}
		}
	}
}