Webová služba ApplicationRead verze 2.0.0 (Obecné webové služby) - popis rozhraní služby
Marbes Consulting s.r.o.
EOS4
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.
Rozhraní webové služby pro čtení informací o aplikacích.
Název |
Popis |
getAllApplications |
Načte seznam všech aplikací řazených podle jména. |
getAllDBConnections |
Vrací seznam všech databázových připojení. |
getApplicationById |
Nalezne aplikaci podle daného Id. |
getApplicationByName |
Nalezne aplikaci podle daného jména. |
getDBConnectionById |
Vyhledá databázové spojení podle Id. |
getDBConnectionByName |
Vyhledá databázové spojení podle názvu. |
getGroupRoleApplications |
Načte seznam aplikací, které má daná skupinová role připojené. |
getOrgRoleApplications |
Načte seznam aplikací, které má daná organizační role připojené. |
getOrgUnitApplications |
Načte seznam aplikací, které má daná organizační jednotka připojené. |
getPersonApplications |
Načte seznam aplikací, které má daná osoba ve všech zařazeních. |
getPersonApplicationsSimpleInput |
Načte seznam aplikací, které má daná osoba ve všech zařazeních. |
getPersonGroupRoleAssignmentApplications |
Načte seznam aplikací, které má daná osoba, která je zařazená do
skupinové role, připojené včetně aplikací přiřazených na osobě. |
getPersonGroupRoleOnlyAssignmentApplications |
Načte seznam aplikací, které má daná osoba, která je zařazená do
skupinové role, připojené vyjma aplikací přiřazených na osobě. |
getPersonOrgRoleAssignmentApplications |
Načte seznam aplikací, které má daná osoba, která je zařazená do
organizační role, připojené včetně aplikací přiřazených na osobě. |
getPersonOrgRoleOnlyAssignmentApplications |
Načte seznam aplikací, které má daná osoba, která je zařazená do
organizační role, připojené vyjma aplikací přiřazených na osobě. |
getPersonOrgUnitAssignmentApplications |
Načte seznam aplikací, které má daná osoba, která je zařazená do
organizační jednotky, připojené včetně aplikací přiřazených na
osobě. |
getPersonOrgUnitOnlyAssignmentApplications |
Načte seznam aplikací, které má daná osoba, která je zařazená do
organizační jednotky, připojené vyjma aplikací přiřazených na
osobě. |
getPersonPrimaryOrgRoleAssignmentApplications |
Načte seznam aplikací na primárním zařazení osoby do organizační role. |
isApplicationNameUnique |
Zjišťuje, zda již neexistuje aplikace se stejným jménem. |
isDBConnectionNameUnique |
Ověřuje, zda je název připojení jedinečný. |
Vyjímka reprezentuje špatný vstupní parametr do web metod.
Vyjímka reprezentuje stav, kdy neexistuje primarni zarazeni osoby.
Výjimka reprezentuje stav, kdy nebyl objekt podle kriterií nalezen.
Vyjímka reprezentuje stav, kdy došlo k problému při práci s organizační strukturou.
Reprezentuje stav, kdy osoba není zařazená
do očekávané entity (jednotková role nebo organizační jednotka).
Reprezentuje neočekávanou výjimku při volání WS. Jejím zdrojem musí být vždy
jiná výjimka.
Načte seznam všech aplikací řazených podle jména.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
clientId |
String |
Ne |
identifikátor klienta, není povinný |
Výstup
Výjimky
Vrací seznam všech databázových připojení.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
clientId |
String |
Ne |
identifikátor klienta, není povinný |
Výstup
Výjimky
Nalezne aplikaci podle daného Id.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
appId |
EosIdentifier |
Ano |
Id požadované aplikace |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v appId |
Výstup
Výjimky
Nalezne aplikaci podle daného jména.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
name |
String |
Ano |
dané jméno aplikace |
clientId |
String |
Ne |
identifikátor klienta, není povinný |
Výstup
Výjimky
Vyhledá databázové spojení podle Id.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
dbConnId |
EosIdentifier |
Ano |
Id požadovaného databázového spojení |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v dbConnId |
Výstup
Výjimky
Vyhledá databázové spojení podle názvu.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
name |
String |
Ano |
dané jméno |
clientId |
String |
Ne |
identifikátor klienta, není povinný |
Výstup
Výjimky
Načte seznam aplikací, které má daná skupinová role připojené. V seznamu
jsou i aplikace přiřazené na nadřazených entitách.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
groupRoleId |
EosIdentifier |
Ano |
Id skupinové role |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v groupRoleId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná organizační role připojené. V
seznamu jsou i aplikace přiřazené na nadřazených entitách.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
orgRoleId |
EosIdentifier |
Ano |
Id organizační role |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v orgRoleId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná organizační jednotka připojené. V
seznamu jsou i aplikace přiřazené na nadřazených jednotkách.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
unitId |
EosIdentifier |
Ano |
Id organizační jednotky |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v orgUnitId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná osoba ve všech zařazeních.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id v personId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná osoba ve všech zařazeních.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
String |
Ano |
eos identifikátor osoby |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná osoba, která je zařazená do
skupinové role, připojené včetně aplikací přiřazených na osobě. V
seznamu jsou i aplikace přiřazené na nadřazených entitách.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
groupRoleId |
EosIdentifier |
Ano |
Id požadované skupinové role |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId nebo groupRoleId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná osoba, která je zařazená do
skupinové role, připojené vyjma aplikací přiřazených na osobě. V
seznamu jsou i aplikace přiřazené na nadřazených entitách.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
groupRoleId |
EosIdentifier |
Ano |
Id požadované skupinové role |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId nebo groupRoleId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná osoba, která je zařazená do
organizační role, připojené včetně aplikací přiřazených na osobě.
V seznamu jsou i aplikace přiřazené na nadřazených entitách.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
orgRoleId |
EosIdentifier |
Ano |
Id požadované organizační role |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId nebo orgRoleId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná osoba, která je zařazená do
organizační role, připojené vyjma aplikací přiřazených na osobě. V
seznamu jsou i aplikace přiřazené na nadřazených entitách.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
orgRoleId |
EosIdentifier |
Ano |
Id požadované organizační role |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId nebo orgRoleId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná osoba, která je zařazená do
organizační jednotky, připojené včetně aplikací přiřazených na
osobě. V seznamu jsou i aplikace přiřazené na nadřazených entitách.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
unitId |
EosIdentifier |
Ano |
Id požadované organizační jednotky |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId nebo orgUnitId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací, které má daná osoba, která je zařazená do
organizační jednotky, připojené vyjma aplikací přiřazených na
osobě. V seznamu jsou i aplikace přiřazené na nadřazených entitách.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
unitId |
EosIdentifier |
Ano |
Id požadované organizační jednotky |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId nebo orgUnitId |
Výstup
EosApplications - kolekce aplikací, pokud nebyla žádná nalezena, vrací prázdnou
kolekci
Výjimky
Načte seznam aplikací na primárním zařazení osoby do organizační role.
Předpis
EosApplications getPersonPrimaryOrgRoleAssignmentApplications (String personId)
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
String |
Ano |
eos identifikátor osoby |
Výstup
EosApplications - seznam aplikací na primárním zařazení osoby do organizační role
Výjimky
Zjišťuje, zda již neexistuje aplikace se stejným jménem.
Předpis
boolean isApplicationNameUnique (String name)
Parametry
Parametr |
Typ |
Povinný |
Popis |
name |
String |
Ano |
název aplikace |
Výstup
boolean - true, pokud aplikace daného jména neexistuje
Výjimky
Ověřuje, zda je název připojení jedinečný.
Předpis
boolean isDBConnectionNameUnique (String name)
Parametry
Parametr |
Typ |
Povinný |
Popis |
name |
String |
Ano |
testované jméno připojení |
Výstup
boolean - true, pokud připojení daného jména neexistuje
Výjimky
Reprezentuje aplikaci. Slouží pro přenos jen "nevirtuálních aplikací".
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
MAX_IMAGE_SIZE |
int |
Ne |
Maximální velikost dat, přenášených jako ikony. Odpovídá maximální velikosti dat DO Image. |
name |
String (255) |
Ano |
Jméno aplikace. |
parameters |
String (256) |
Ne |
Parametry příkazové řádky. |
author |
String (127) |
Ano |
Autor aplikace. |
description |
String (1024) |
Ne |
Popis aplikace. |
path |
String (255) |
Ne |
Cesta k aplikaci. Kde je fyzicky spustitelný soubor na síti - v případě
webové URL. |
icon |
String (2147483647) |
Ne |
Kde je uložena na disku nebo v síti ikona aplikace. |
appServerName |
String (256) |
Ne |
Jméno aplikačního serveru. |
testing |
Boolean |
Ne |
Je aplikace v testovacím režimu? |
appCode |
String (100) |
Ano |
Kód aplikace. Zkratka subsystému (RB, ROB...). |
serverUrl |
String (500) |
Ne |
URL aplikačního serveru pro webové služby. |
version |
String (50) |
Ne |
Verze aplikace. |
dbConnection |
EosDbConnection |
Ne |
Databáze přiřazená aplikaci. |
guid |
String |
Ne |
GUID aplikaci. |
Reprezentuje wrapper pro kolekci aplikací.
Jméno atributu |
Datový typ |
Povinné |
Popis |
application |
List<EosApplication> |
Ne |
Kolekce aplikací. |
Výčet typů databázových serverů.
Hodnota |
Popis |
ORACLE |
Oracle DB server. |
MSSQL |
Microsoft SQL server. |
POSTGRESQL |
PostgreSQL server. |
Reprezentuje databázové připojení.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
name |
String (127) |
Ano |
Název databáze. |
dbType |
EosDatabaseType |
Ano |
Typ databázového serveru. |
username |
String (255) |
Ano |
Přihlašovací jméno do databáze. |
password |
String (255) |
Ne |
Heslo do databáze. Jen pro účel zápisu. Při čtení je vždy nevyplněné. |
connectionString |
String (1024) |
Ano |
JDBC connection string. |
Reprezentuje wrapper pro kolekci databázových připojení.
Jméno atributu |
Datový typ |
Povinné |
Popis |
dbConnection |
List<EosDbConnection> |
Ne |
Kolekce databázových připojení. |
Reprezentuje identifikátor webového objektu slučující interní a externí ID.
Jméno atributu |
Datový typ |
Povinné |
Popis |
externalId |
String (255) |
Ne |
Id entity v externím systému. |
eosIdentifier |
String (255) |
Ne |
Unikátní identifikátor entity v EOSu (v rámci konkrétního potomka entity,
tedy např. organizační role), při importu do EOSu nemá význam. |