Version:
  1. Webové služby

    Article: AN0002060 Updated: 16.10.2018 Displayed: 347x

    Webové služby (WS) představují jednu z možností jak externě načítat nebo ukládat data do systému ObjectGears. Výhoda WS je v propojení více aplikací do jednoho většího celku. Propojení je možné přes různé platformy (windows, unix, linux) nebo různé programovací jazyky (.NET, java...).

    Přístup na webové služby (WSDL)

    Pro přístup na všechny webové služby použijte adresu:  http://vasweb/OGService.asmx

    Pro WSDL popis služby je k dispozici stránka: http://vasweb/OGService.asmx?WSDL

    Povolení webových služeb

    Webové služby jsou ve výchozí konfiguraci zakázané a je třeba je explicitně povolit. Povolení je třeba na třech úrovních. Toto kaskádové povolení je pro zvýšení bezpečnosti (omezení nepovoleného volání) a dává též možnost webové služby okamžitě zakázat.

    Povolení v souboru web.config

    V první řadě je třeba webové služby povolit v souboru web.config. Jedná se o nastavení EnableWebServices. Povolené hodnoty jsou:

    • True - služby jsou povoleny
    • False – služby jsou zakázány

    Pokud nechcete webové služby používat, pak nechte volbu na False.

    Povolení na třídě / dotazu / exportu / importu

    Na konkrétní třídě / dotazu / exportu / importu / workflow nastavte volbu Povolit přístup přes webové služby a uložte.

    Přístupové role

    Poslední stupeň pro povolení volání webové služby je v nastavení příslušné role pro účet, pod kterým budete službu volat. Tento účet musí být zaveden jako uživatel v systému ObjectGears. Požadované právo závisí na webové službě, kterou chcete volat (viz následující tabulka). Můžete tak různým uživatelům (servisním účtům) povolit jen různé WS. Jedna může jen číst z určitých tříd a jiná aktualizovat záznamy.
     

    Webová služba Právo

    RunImport

    RunImportById

    Spustit import

    RunExport

    RunExportById

    Spustit export

    GetData

    GetDataById

    Čtení dat v detailu
    GetDataByFilter Čtení dat v detailu
    GetDatas Čtení dat v detailu
    InsertData Vkládání dat
    UpdateData Změna dat
    DeleteData Mazání dat
    ...WorkflowSeq Spustit workflow
    CallEvent Aktivace události

     Seznam webových služeb

    V následujících tabulkách je seznam WS rozdělených podle skupin použití, které systém ObjectGears poskytuje.

    Přehled všech webových služeb a jejich definici naleznete na adrese: http://__vas_web__/OGService.asmx

    Služby pro práci s daty

    Webová služba Popis

    GetData

    GetDataById

    Metoda vrátí jeden záznam pro vybranou třídu nebo dotaz.
    GetDataByFilter Metoda vrátí první záznam vyhledaný dle filtru.
    GetDatas Metoda vrátí záznamy dle zadaného filtru.
    InsertData Metoda vloží jeden záznam do třídy.
    InsertDatas Metoda vloží více záznamů do třídy.
    UpdateData Metoda změní jeden existující záznam ve třídě.
    UpdateDatas Metoda změní více existujících záznamů ve třídě.
    DeleteData Metoda smaže jeden existující záznam ve třídě.
    DeleteDatas Metoda smaže více existujících záznamů ve třídě.

    Služby pro práci s importem a exportem

    Webová služba Popis

    RunImport

    RunImportById

    Metoda spustí vybraný import.

    RunExport

    RunExportById

    Metoda spustí vybraný export.

    Služby pro práci s workflow

    Webová služba Popis

    RunWorkflowSeq

    RunWorkflowSeq2

    Metoda spustí vybrané workflow.
    FailedWorkflowSeq Metoda ukončí vybrané workflow a nastaví, že skončilo s chybou.
    CancelWorkflowSeq Metoda ukončí vybrané workflow a nastaví, že bylo uživatelem zrušeno.
    PauseWorkflowSeq Metoda pozastaví vybrané workflow a nastaví mu stav pauza.
    ContinueWorkflowSeq Metoda pustí pozastavené vybrané workflow.
    GetWorkflowSeqState Metoda vrátí stav vybraného workflow.
    CallEvent Metoda aktivuje událost.

    Ostatní služby

    Webová služba Popis
    RunScript Metoda spustí skript definovaný v modelu.
    CheckParameter Metoda zkontroluje, zda souhlasi zadaná hodnota parametru s aktuální hodnotou v ObjectGears.

    Výsledek volání webové služby

    Všechny webové služby vrací některou instanci objektu OG…Result. Výsledek obsahuje informaci, zda volání proběhlo úspěšně či došlo k chybě.

    Výsledný objekt Popis
    OGDataResult Výsledek pro volání WS pro práci s daty.
    OGImportResult Výsledek pro volání WS pro import.
    OGExportResult Výsledek pro volání WS pro export.
    OGWorkflowSeqResult Výsledek pro volání WS pro workflow.
    OGScriptResult Výsledek pro volání WS RunScript.

    Všechny tyto výsledné objekty, které vrací WS mají tyto společné vlastnosti:

    Vlastnost Popis
    IsOk Příznak za při volání WS došlo k chybě.
    ErrorMessage Seznam chyb.

    Tyto vlastnosti informují, zda volání WS dopadlo úspěšně či nikoli. Za chybu se považuje neočekávaná výjimka nebo zásadní chyba.

  2.    ---
    Your rating:
    Rated by users: 0x
  3. Top
SearchTitle
×