Webová služba Application verze 6.0.0 (Obecné webové služby) - popis rozhraní služby

Vygenerováno z verze 4.21.0.19.0.

Podmínky omezující zveřejnění

Autorem tohoto dokumentu je společnost MARBES CONSULTING s.r.o. Dokument obsahuje informace důvěrného charakteru a ve smyslu definice autorského práva (viz § 2, odst. 1 Zákona č. 121/2000 Sb., zákon o právu autorském) je duševním vlastnictvím autora a předmětem práva autorského. Dokument smí být použit výhradně za účelem, za kterým byl poskytnut a nesmí být bez předchozího souhlasu autora citován, kopírován, vytěžován1 nebo předán třetí fyzické či právnické osobě.

© 2009 MARBES CONSULTING s.r.o.

1 Vytěžováním se podle zákona č. 121/2000 Sb. rozumí trvalý nebo dočasný přepis celého obsahu nebo jeho podstatné části na jiný podklad, a to jakýmikoli prostředky nebo jakýmkoli způsobem.


Obsah


Obecné informace

Rozhraní pro práci s aplikacemi a atributy. {

Seznam poskytovaných metod

Název Popis
findApplicationsByFilter Hledání aplikací podle předaného filtru.
findApplicationsByIds Hledání aplikací podle předaného seznamu id.
findKerberosKey Načte informace o kerberos klíči.
getApplicationById Metoda nalezne aplikaci dle předaného identifikátoru.
getConfiguration Vrátí konfigurační mapu.
getNextApplications Načtení další části stránkovaného seznamu aplikací.
getSyncApplicationAttributesToDelete Zjistí, které atributy by se během synchronizace smazaly.
syncApplication Provede synchronizaci aplikace a jejich atributů, před voláním této metody je doporučeno zjištění, kolik atributů se bude během synchronizace mazat a nechat potvrzení synchronizace např.
updateConfiguration Provede aktualizaci konfigurace.

Seznam struktur dat

Název Popis
EosApplication Reprezentuje aplikaci.
EosApplicationIds Objekt obsahující seznam id aplikací.
EosApplicationRespFilter Objekt definuje rozsah dat, které se budou u aplikací plnit.
EosApplications Reprezentuje seznam aplikací.
EosAttributeToDelete Informace o atributu (včetně počtu jejich přiřazených hodnot), který se bude při synchronizaci aplikace mazat.
EosAttributeUnderMulticolumnToDelete Informace o atributu (včetně počtu jejich přiřazených hodnot), který ke pod vícesloupcovým a který se bude při synchronizaci aplikace mazat.
EosAttributes Reprezentuje wrapper pro kolekci různých atributů.
EosAttributesToDelete Obsahuje seznam atributů (včetně počtu jejich přiřazených hodnot), které se budou při synchronizaci aplikace mazat.
EosBooleanAttribute Reprezentuje boolean atribut.
EosDBConnection Reprezentuje databázové připojení.
EosDatabaseType Výčet typů databázových serverů.
EosEnumAttribute Reprezentuje výčtový atribut.
EosInnerAttribute Reprezentuje Inner atribut.
EosInnerAttributeType Seznam typů vnitřního atributu.
EosKerberosKey
EosMulticolumnAttribute Reprezentuje vícesloupcový atribut.
EosMulticolumnAttributes Reprezentuje wrapper pro kolekci různých atributů, které tvoří vícesloupcový.
EosPaging Objekt obsahující informace pro stránkování.
EosRangeValue Reprezentuje hodnotu oboru hodnot výčtového atributu.
EosRangeValues Reprezentuje wrapper pro obor hodnot enum atributu.
EosSelectAttribute Reprezentuje selektový atribut.
EosStringAttribute Reprezentuje stringový atribut.
EosWSAttribute Reprezentuje WS atribut.

Výjimky

EosIllegalArgumentException

Chybný vstupní argument.

EosInternalException

Reprezentuje neočekávanou výjimku při volání webových služeb.

EosListNotFoundException

List podle předaného id nebyl nalezen.

EosObjectNotFoundException

Objekt nebyl podle předaného id nalezen.

EosObjectNotFoundException

Nedostatečná oprávnění.

EosSSessionNotFoundException

Session s předaným id nebyla nalezena.


Popis poskytovaných metod

findApplicationsByFilter

Hledání aplikací podle předaného filtru.

Předpis

EosApplications findApplicationsByFilter (String sid, String filter, EosApplicationRespFilter respFilter)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
filter String Ne filtr na aplikace
respFilter EosApplicationRespFilter Ne filtr který umožňuje určit, jaká data budou vrácena v objektu aplikace (např. jestli mají být naplněny i atributy atd.)

Výstup

EosApplications - seznam aplikací podle předaného filtru

Výjimky

EosIllegalArgumentException - byl předán nevalidní parametr
EosSSessionNotFoundException - neexistuje session
EosInternalException - vniřní chyba

findApplicationsByIds

Hledání aplikací podle předaného seznamu id.

Předpis

EosApplications findApplicationsByIds (String sid, EosApplicationIds applicationIds, EosApplicationRespFilter respFilter)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
applicationIds EosApplicationIds Ano seznam id aplikací
respFilter EosApplicationRespFilter Ne filtr který umožňuje určit, jaká data budou vrácena v objektu aplikace (např. jestli mají být naplněny i atributy atd.)

Výstup

EosApplications - nalezené aplikace, pokud podle některých id nebyly aplikace nalezeny, nebudou ve výsledku obsaženy

Výjimky

EosIllegalArgumentException - chybné vstupní parametry
EosSSessionNotFoundException - neexistující session
EosInternalException - vnitřní chyba

findKerberosKey

Načte informace o kerberos klíči. Pokud aplikace nemá klíč vrátí null.

Předpis

EosKerberosKey findKerberosKey (String sid, String applicationId)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
applicationId String Ano id aplikace

Výstup

EosKerberosKey - kerberos klíč nebo null pokud aplikace nemá klíč

Výjimky

EosObjectNotFoundException - pokud se aplikaci nepodařilo dle identifikátoru nalézt
EosIllegalArgumentException -
EosSSessionNotFoundException - neexistující session
EosInternalException - vnitřní chyba
EosObjectNotFoundException - volající nemá práva na tuto akci

getApplicationById

Metoda nalezne aplikaci dle předaného identifikátoru.

Předpis

EosApplication getApplicationById (String sid, String applicationId, EosApplicationRespFilter respFilter)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
applicationId String Ano id aplikace
respFilter EosApplicationRespFilter Ne filtr který umožňuje určit, jaká data budou vrácena v objektu aplikace (např. jestli mají být naplněny i atributy atd.)

Výstup

EosApplication - nalezená aplikace

Výjimky

EosObjectNotFoundException - pokud se aplikaci nepodařilo dle identifikátoru nalézt
EosIllegalArgumentException - chybné vstupní parametry
EosSSessionNotFoundException - neexistující session
EosInternalException - vnitřní chyba

getConfiguration

Vrátí konfigurační mapu.

Předpis

EosCfgValueHist getConfiguration (String applicationId, boolean readHistory)

Parametry

Parametr Typ Povinný Popis
applicationId String Ano
readHistory boolean Ano

Výstup

EosCfgValueHist - kompletní konfigurace pro aplikaci (za idApl)

Výjimky

EosObjectNotFoundException -

getNextApplications

Načtení další části stránkovaného seznamu aplikací.

Předpis

EosApplications getNextApplications (String sid, String lid)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
lid String Ano list id

Výstup

EosApplications - další část stránkovaného seznamu aplikací

Výjimky

EosListNotFoundException - lid daného id neexistuje
EosIllegalArgumentException - byl předán nevalidní parametr
EosSSessionNotFoundException - neexistuje session
EosInternalException - vniřní chyba

getSyncApplicationAttributesToDelete

Zjistí, které atributy by se během synchronizace smazaly.

Předpis

EosAttributesToDelete getSyncApplicationAttributesToDelete (String sid, EosApplication application)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
application EosApplication Ano aplikace která se bude aktualizovat metodou syncApplication

Výstup

EosAttributesToDelete - informace o atributech

Výjimky

EosObjectNotFoundException - při předání neplatného identifikátoru (aplikace k aktualizaci nebyla nalezena)
EosInternalException - vnitřní chyba
EosSSessionNotFoundException - neexistující session
EosIllegalArgumentException - chybné vstupní parametry

syncApplication

Provede synchronizaci aplikace a jejich atributů, před voláním této metody je doporučeno zjištění, kolik atributů se bude během synchronizace mazat a nechat potvrzení synchronizace např. na uživateli. Pokud nebude některý atribut poslán, bude z EOS odstraněn včetně všech jeho přiřazených hodnot. Přejmenování atributů není podporováno!

Musí být předán identifikátor existující aplikace, ostatní identifikátory (např. atributy a výčtové hodnoty) nesmí být vyplněny.

Předpis

void syncApplication (String sid, EosApplication application)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
application EosApplication Ano aplikace která bude aktualizována

Výjimky

EosObjectNotFoundException - při předání neplatného identifikátoru (aplikace k aktualizaci nebyla nalezena)
EosInternalException - vnitřní chyba
EosSSessionNotFoundException - neexistující session
EosIllegalArgumentException - chybné vstupní parametry

updateConfiguration

Provede aktualizaci konfigurace. Položku založí nebo aktualizuje. Pokud je hodnota blank, tak položku smaže.

Předpis

void updateConfiguration (String applicationId, String userName, EosCfgValue map)

Parametry

Parametr Typ Povinný Popis
applicationId String Ano
userName String Ano
map EosCfgValue Ano mapa

Výjimky

EosObjectNotFoundException -

Popis struktur dat

EosApplication

Reprezentuje aplikaci. Slouží pro přenos jen "nevirtuálních aplikací".

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno aplikace.
parameters String Ne Parametry příkazové řádky.
author String Ne Autor aplikace.
description String Ne Popis aplikace.
formattedDescription String Ne Podrobný naformátovaný popis aplikace, jedná se o xhtml kód.
path String Ne Cesta k aplikaci. Kde je fyzicky spustitelný soubor na síti - v případě webové URL.
icon String Ne Kde je uložena na disku nebo v síti ikona aplikace.
appServerName String Ne Jméno aplikačního serveru.
testing Boolean Ne Je aplikace v testovacím režimu? Příznak pouze pro čtení.
appCode String Ne Kód aplikace. Zkratka subsystému (RB, ROB...).
serverUrl String Ne URL aplikačního serveru pro webové služby.
version String Ne Verze aplikace.
dbConnection EosDBConnection Ne Databáze přiřazená aplikaci.
attributes EosAttributes Ne Atributy aplikace.

EosApplicationIds

Objekt obsahující seznam id aplikací.

Jméno atributu Datový typ Povinné Popis
applicationIds List<String> Ne Seznam id aplikací.

EosApplicationRespFilter

Objekt definuje rozsah dat, které se budou u aplikací plnit.

Jméno atributu Datový typ Povinné Popis
attributes boolean Ne Příznak, zda se mají plnit data o atributech aplikace.
dbConnections boolean Ne Příznak, zda se mají plnit data o databázových připojeních u aplikací a atributů.
rangeValues boolean Ne Příznak, zda se má plnit seznam možných výčtových hodnot u enum atributů.

EosApplications

Reprezentuje seznam aplikací.

Jméno atributu Datový typ Povinné Popis
applications List<EosApplication> Ne Seznam aplikací.
paging EosPaging Ne Stránkování.

EosAttributeToDelete

Informace o atributu (včetně počtu jejich přiřazených hodnot), který se bude při synchronizaci aplikace mazat.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno atributu.
description String Ne Popis atributu.
displayName String Ne Zobrazované jméno.
inheritable Boolean Ne Příznak, zda se mají hodnoty atributu dědit.
singleValue Boolean Ne Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový.
valuesCount Long Ne Počet přiřazených hodnot atributu.

EosAttributeUnderMulticolumnToDelete

Informace o atributu (včetně počtu jejich přiřazených hodnot), který ke pod vícesloupcovým a který se bude při synchronizaci aplikace mazat.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno atributu.
description String Ne Popis atributu.
displayName String Ne Zobrazované jméno.
inheritable Boolean Ne Příznak, zda se mají hodnoty atributu dědit.
singleValue Boolean Ne Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový.
valuesCount Long Ne Počet přiřazených hodnot atributu.
multicolumnId String Ne Identifikátor vícesloupcového atributu, pod který tento atribut patří.

EosAttributes

Reprezentuje wrapper pro kolekci různých atributů.

Jméno atributu Datový typ Povinné Popis
booleanAttributes List<EosBooleanAttribute> Ne Kolekce boolean atributů.
enumAttributes List<EosEnumAttribute> Ne Kolekce výčtových atributů.
selectAttributes List<EosSelectAttribute> Ne Kolekce selektových atributů.
stringAttributes List<EosStringAttribute> Ne Kolekce stringových atributů.
wsAttributes List<EosWSAttribute> Ne Kolekce WS atributů.
innerAttributes List<EosInnerAttribute> Ne Kolekce WS atributů.
multicolumnAttributes List<EosMulticolumnAttribute> Ne Kolekce vícesloupcových atributů.

EosAttributesToDelete

Obsahuje seznam atributů (včetně počtu jejich přiřazených hodnot), které se budou při synchronizaci aplikace mazat.

Jméno atributu Datový typ Povinné Popis
attributes List<EosAttributeToDelete> Ne Seznam atributů, které se budou při synchronizaci aplikace mazat.
attributesUnderMulticolumn List<EosAttributeUnderMulticolumnToDelete> Ne Seznam atributů pod vícesloupcovými atributy, které se budou při synchronizaci aplikace mazat.

EosBooleanAttribute

Reprezentuje boolean atribut.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno atributu.
description String Ne Popis atributu.
displayName String Ne Zobrazované jméno.
inheritable Boolean Ne Příznak, zda se mají hodnoty atributu dědit.
singleValue Boolean Ne Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový.
defaultValue Boolean Ne Výchozí hodnota.
conflictValue Boolean Ne Hodnota, která se má použít, pokud při výpočtu dojde ke konfliktu. Pokud je null je výsledkem false.

EosDBConnection

Reprezentuje databázové připojení.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Název databáze.
databaseType EosDatabaseType Ne Typ databázového serveru.
userName String Ne Přihlašovací jméno do databáze.
password String Ne Heslo do databáze. Jen pro účel zápisu. Při čtení je vždy nevyplněné.
connectionString String Ne JDBC connection string.

EosDatabaseType

Výčet typů databázových serverů.

Hodnota Popis
ORACLE Oracle DB server.
MSSQL Microsoft SQL server.
POSTGRESQL PostgreSQL server.

EosEnumAttribute

Reprezentuje výčtový atribut.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno atributu.
description String Ne Popis atributu.
displayName String Ne Zobrazované jméno.
inheritable Boolean Ne Příznak, zda se mají hodnoty atributu dědit.
singleValue Boolean Ne Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový.
validClass String Ne Hodnoty atributu mohou nabývat pouze hodnot z oboru, jejichž typ odpovídá tomuto regulárnímu výrazu. Pokud je null není filtrování uplatněno.
defaultValue String Ne Výchozí hodnota výčtového atributu.
rangeValues EosRangeValues Ne Výčet hodnot.

EosInnerAttribute

Reprezentuje Inner atribut.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno atributu.
description String Ne Popis atributu.
displayName String Ne Zobrazované jméno.
inheritable Boolean Ne Příznak, zda se mají hodnoty atributu dědit.
singleValue Boolean Ne Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový.
validClass String Ne Hodnoty atributu mohou nabývat pouze hodnot z oboru, jejichž typ odpovídá tomuto regulárnímu výrazu. Pokud je null není filtrování uplatněno.
tree Boolean Ne Stromový atribut.
joinValue Boolean Ne Hodnoty atributu se skládají z typu entity a jejího identifikátoru.
innerType EosInnerAttributeType Ne Typ vnitřního atributu.
innerAttValTypes String Ne Seznam možných typů hodnot atributu.

EosInnerAttributeType

Seznam typů vnitřního atributu.

Hodnota Popis
ORG_STRUCT Organizační struktura.
APPLICATIONS Aplikace.
PROFILES Profily.

EosKerberosKey

Jméno atributu Datový typ Povinné Popis
key String Ne Klíč v zakódovaný base64.

EosMulticolumnAttribute

Reprezentuje vícesloupcový atribut.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno atributu.
description String Ne Popis atributu.
displayName String Ne Zobrazované jméno.
inheritable Boolean Ne Příznak, zda se mají hodnoty atributu dědit.
singleValue Boolean Ne Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový.
attributes EosMulticolumnAttributes Ne Atributy, které tvoří vícesloupcový atribut.

EosMulticolumnAttributes

Reprezentuje wrapper pro kolekci různých atributů, které tvoří vícesloupcový.

Jméno atributu Datový typ Povinné Popis
attributesOrder List<String> Ne Pořadí atributů v rámci vícesloupcového atributu. Seznam názvů všech atributů, které tvoří vícesloupcový.
booleanAttributes List<EosBooleanAttribute> Ne Kolekce boolean atributů.
enumAttributes List<EosEnumAttribute> Ne Kolekce výčtových atributů.
selectAttributes List<EosSelectAttribute> Ne Kolekce selektových atributů.
stringAttributes List<EosStringAttribute> Ne Kolekce stringových atributů.
wsAttributes List<EosWSAttribute> Ne Kolekce WS atributů.
innerAttributes List<EosInnerAttribute> Ne Kolekce WS atributů.

EosPaging

Objekt obsahující informace pro stránkování.

Jméno atributu Datový typ Povinné Popis
lid String Ne List id nebo null, pokud stránkování není vyžadováno.
start int Ne Index prvního záznamu, který byl aktuálně vrácen.
totalCount int Ne Celkový počáteční záznamů.
hasNext boolean Ne Příznak, zda jsou k dispozici ještě další záznamy.

EosRangeValue

Reprezentuje hodnotu oboru hodnot výčtového atributu.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
content String Ne Samotná hodnota atributu.
comment String Ne Komentář hodnoty atributu.
weight Integer Ne Určuje váhu hodnoty atributu.

EosRangeValues

Reprezentuje wrapper pro obor hodnot enum atributu.

Jméno atributu Datový typ Povinné Popis
values List<EosRangeValue> Ne Kolekce hodnot oboru.

EosSelectAttribute

Reprezentuje selektový atribut.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno atributu.
description String Ne Popis atributu.
displayName String Ne Zobrazované jméno.
inheritable Boolean Ne Příznak, zda se mají hodnoty atributu dědit.
singleValue Boolean Ne Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový.
validClass String Ne Hodnoty atributu mohou nabývat pouze hodnot z oboru, jejichž typ odpovídá tomuto regulárnímu výrazu. Pokud je null není filtrování uplatněno.
sqlCommand String Ne Select příkaz pro dotaz do číselníku. Pro atributy, jejichž hodnoty odpovídají řádkům z číselníku. (SQL výsledku).
sqlValueColumn String Ne Jméno sloupce z SQL dotazu (sqlCommand), který se má vzít jako obor hodnot.
sqlKeyColumn String Ne Jméno sloupce z SQL dotazu (sqlCommand), který obsahuje jednoznačnou identifikaci (ID) hodnot.
sqlTreeKey String Ne Jméno sloupce z SQL dotazu (sqlCommand), který obsahuje klíč pro vázání hodnot do stromu. Pro nestromové atributy nemá význam.
sqlTreeParent String Ne Jméno sloupce z SQL dotazu (sqlCommand), který obsahuje klíč rodiče pro vázání hodnot do stromu. Pro nestromové atributy nemá význam.
sqlClassColumn String Ne Jméno sloupce z SQL dotazu (sqlCommand), který obsahuje třídu (typ dané hodnoty). Pokud je null, není brán v potaz.
sqlDescriptionColumn String Ne Název sloupce pro popis hodnoty.
dbConnection EosDBConnection Ne Připojení k databázi.

EosStringAttribute

Reprezentuje stringový atribut.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno atributu.
description String Ne Popis atributu.
displayName String Ne Zobrazované jméno.
inheritable Boolean Ne Příznak, zda se mají hodnoty atributu dědit.
singleValue Boolean Ne Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový.
regexp String Ne Regulární výraz, jemuž musí odpovídat nastavovaná hodnota. Pokud je null validace se neprovádí.
regexpDescription String Ne Komentář regulárního výrazu - zobrazuje se uživateli.
defaultValue String Ne Výchozí hodnota atributu.
conflictValue String Ne Hodnota, která se má použít, pokud při výpočtu dojde ke konfliktu.

EosWSAttribute

Reprezentuje WS atribut.

Jméno atributu Datový typ Povinné Popis
id String Ne Identifikátor, pro range value není povinný.
name String Ne Jméno atributu.
description String Ne Popis atributu.
displayName String Ne Zobrazované jméno.
inheritable Boolean Ne Příznak, zda se mají hodnoty atributu dědit.
singleValue Boolean Ne Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový.
validClass String Ne Hodnoty atributu mohou nabývat pouze hodnot z oboru, jejichž typ odpovídá tomuto regulárnímu výrazu. Pokud je null není filtrování uplatněno.
url String Ne URL webové služby, ze které bude načítán obor hodnot.
userName String Ne Uživatelské jméno.
password String Ne Uživatelské jméno.
treeAttribute Boolean Ne Příznak, zda se jedné o stromový atribut.
urlRelative Boolean Ne Příznak určující zda, je URL uvedena v relativním či absolutním formátu.
wsdlUrl String Ne URL webové služby, ze které bude načítán obor hodnot.
script String Ne Skript pro načtení hodnot z WS.
additionScript String Ne Dodatečný skript pro načtení plochého seznamu hodnot u stromového atributu .
serviceQName String Ne Kvalifikovaný název služby webové služby.
portQName String Ne Kvalifikovaný název portu webové služby.