Připravované změny ve Web API

Od verzie 26.3 sa už začne kontrolovať právo na funkciu WebApi - väzba medzi dokladmi. Požiadavky sa vykonajú len v prípade, že bude mať používateľ toto právo nastavené. Aktuálne funguje v režime upozornenia, komu právo chýba, ale požiadavku dovolí vykonať.

Vyúčtovanie zálohových listov do faktúr je v API teraz podporované výhradne pomocou importných managerov. Priama editácia objektov receiveddepositusages a issueddepositusages na účely vytvorenia väzby bola zrušená.

Bude zavedené právo pre aplikáciu úlohy. Právo na úlohy ako celok. Je teda potrebné si pri prechode na túto verziu nastaviť práva používateľom, ktorí úlohy používajú. Práva sú už dostupné od verzie 26.1. Je teda možné ich používateľom nastaviť už teraz.

Od verzie 26.1 API kontroluje, či je položka objektu editovateľná alebo nie. Editovateľnosť položky sa môže meniť počas vytvárania BO, a to podľa toho, ako sa nastavujú iné položky objektu. V prípade, že položka nie je editovateľná, ale dochádza prostredníctvom API k jej nastaveniu, je vrátená chyba.

Vypnutie vykonáte v konfiguračnom súbore apiserver.yaml, sekcia API, parameter strictObjectModifyCheck prepnutím na hodnotu false. Napr. strictObjectModifyCheck: false.

Kontrola funguje ako pri vytváraní objektov bežným spôsobom cez endpointy, tak aj v stave na serveri.

• Bude zaveden nový parametr dotazů selectschema, který určuje množinu vracených polí, pokud není uvedený parametr select.

• Bude zaveden nový parametr konfiguračního souboru apiserver.yaml s názvem minimalSelectSchema a hodnotami Ano/Ne, kterým se nastavuje chování, pokud v dotazu není uveden ani jeden z parametrů select a selectschema. Od verze 26.1 bude jeho výchozí hodnota Ne. Pro optimalizaci rychlosti API je dobré nastavit hodnotu na ANO.

Od verze 25.0 je v serverstate naimplementován nový způsob zadávání parametrů do importních managerů (IM). Tento způsob má výhodu v tom, že odpovídá způsobu práce s BO a zároveň jsou jednotlivé parametry importních managerů (dále jen IM), na rozdíl od původního způsobu podrobně zdokumentovány. Aby se předešlo rozdílnému zadávání parametrů IM v rámci API, rozhodli jsme o sjednocení i v klasickém volání IM. API bude akceptovat nový i původní způsob zadávání parametrů do importních managerů.

(GET, POST, PUT, DELETE /spojení/BO/ID/kolekce)

Abychom zajistili správné konzistentní chování na všech BO, lze nově číst, vytvářet, modifikovat a mazat řádky kolekcí pouze přes hlavičkový objekt. V rozšířeném query dotazování je i nadále možné číst data přímo z objektu řádků.

Dříve

POST /SPOJENI/firms/1000000101/firmoffices
{“code”: “kancl”}

Nové chování toto zakazuje a kolekce se editují pouze s hlavním BO

PUT /SPOJENI/firms/1000000101
{
“firmoffices”: {“code”: “kancl”}
}

Vypnutie vykonáte v konfiguračnom súbore v APIServer.yam includeCollectionPaths: false nastavením na hodnotu true. Napr. includeCollectionPaths: true.

#false => new way API doesn´t contain special paths for collections

#true => old way API contains paths for collections

Výchozí hodnota: false

Bolo zavedené právo pre väzbu medzi dokladmi. Toto právo k funkcii aktuálne funguje v režime upozornenia, komu právo chýba, ale požiadavka dovolí vykonať. V budúcich verziách bude toto právo plne funkčné a požiadavky sa vykonajú len v prípade, že bude mať používateľ toto právo nastavené. Upozornenie prebieha v rámci aplikácie Web API monitoring a zápisom do Servisnej knižky.

Bude zavedené právo pre aplikáciu úlohy. Právo na úlohy ako celok. Je teda potrebné si pri prechode na túto verziu nastaviť práva používateľom, ktorí úlohy používajú. Právo bude zavedené už do verzie 26.1 a kontrolovať sa začne v budúcich verziách.

• Odstraněn endpoint POST /{controller}/query. Místo něj třeba použít POST /query

• Endpoint GET /{controller}/{id}/payments nahrazen za endpoint /{controller}/{id}/docpaymentsources

• Endpoint GET /{controller}/{id}/relations nahrazen za endpoint /{controller}/{id}/xrelations

V celém systému byl na všech business objektech v registraci fieldů nastaven příznak fkAutoRO u položek, které jsou určeny pouze pro čtení. Seznam všech business objektů, u nichž byly provedeny úpravy, najdete v tomto přehledu.

Doporučujeme zkontrolovat seznam položek a v případě, že některou z nich používáte pro zápis, upravit příslušný API dotaz (nebo aplikaci) tak, aby odpovídal aktuálnímu stavu.

Tyto endpointy budou v rámci verze 25.4 trvale odstraněny, protože nebyly využívány a jejich funkcionalita se v systému nepoužívala nebo byla zastaralá. Neexistuje za ně náhrada. Jejich odstranění nebude mít dopad na běžné používání API.

abrahelpdesksecusers, accaccruals, accdocqueueunusednumbers, appserverconnectionslogs, assetleasingcards, cdconfirmlinks, cdconfirmsettings, crashinfo, crmactivityforoverviews, crmactivityqueueunusednumbers, crpplansettings, crpplanvariants, crpvariantsflows, databoxmessreceivedcontents, databoxmessreceiveds, databoxmesssentcontents, databoxmesssents, devblobs, devices, docqueueunusednumbers, dualcurrencysettings, ecdfiscaltransactions, emailreceiveduidls, execcalccharts, firmmenuitemlinks, firmmenuitemlinks, mlbexcludedperiods, mlbrepeatedroutes, mossservices, msgredirections, namedmasks, payments, payremindersetexclusions, personmenuitemlinks, plmjooutputitems, plmoperationwsis, plmreqcostinginputitems, plmreqcostingoutputitems, plmreqinputitems, plmreqoutputitems, plmreqoutputitems, plmwsirelations, pmobjectstatehistories, poscashnotaccountedpaids, poscashnotaccountedreceiveds, postouchsets, productiontasks, restrictiondispprops, restrictionusages, retirementreportuserdefrows, sitedatas, sourcegroupidenticals, sourcegroups, usedsites, usedsitesactions, useremailhistories, usergridcolumnsdefs, userxlinks, vatclosingdocuments, wageimportrelationheaders, wageimportsabsences, wageimportssickbenefits, wagelistcommons, wageoperationimports, wagesettings, watchdogmessages, whispererdefautocompletes, whispererdeffastsearchs, whispererdeflikes

Tyto endpointy projdou výraznou změnou struktury nebo logiky. Původní způsob volání již nebude podporován a bude nutné upravit implementaci podle nových pravidel. V některých případech dojde k nahrazení přímého volání Web API za přístup přes vlastněné objekty, sjednocený dotazovací mechanismus nebo budou tyto endpointy sloučeny s jinými funkcionalitami. Klientské aplikace musí být upraveny podle aktuálních příkladů a dokumentace.