Webová služba AttributeRead verze 1.1.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 atributech. Čte vždy jen
neskryté atributy.
Vyjímka reprezentuje špatný vstupní parametr do web metod.
Vyjímka 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).
Vyjímka reprezentuje chybu získávání range values.
Reprezentuje neočekávanou výjimku při volání WS. Jejím zdrojem musí být vždy
jiná výjimka.
Vrátí atributy aplikace.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
appId |
EosIdentifier |
Ano |
Id aplikace, jejíž atributy chceme zjistit |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v appId |
Výstup
Výjimky
Najde atribut předané aplikace s požadovaným jménem.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
appId |
EosIdentifier |
Ano |
Id aplikace, které náleží hledaný atribut |
name |
String |
Ano |
jméno hledaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v appId |
Výstup
Výjimky
Načte obor hodnot konkrétního obecného výčtového atributu s externími
hodnotami, tedy selektového nebo WS atributu.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
attrId |
EosIdentifier |
Ano |
ID daného selektového nebo WS atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v attrId |
Výstup
Výjimky
Najde boolean atribut daného Id.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
attrId |
EosIdentifier |
Ano |
Id požadovaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v attrId |
Výstup
Výjimky
Najde výčtový atribut daného Id.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
attrId |
EosIdentifier |
Ano |
Id požadovaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v attrId |
Výstup
Výjimky
Načte hodnotu atributu v dané skupinové roli. Dědičnost hodnot NENÍ brána
v potaz (v případě neexistence hodnoty na entitě NEbudou prohledáváni
předci).
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
unitId |
EosIdentifier |
Ano |
Id požadované skupinové role |
attrId |
EosIdentifier |
Ano |
Id hledaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v orgUnitId nebo attrId |
Výstup
Výjimky
Načte hodnoty atributu v dané skupinové roli. Dědičnost hodnot je brána v
potaz (v případě neexistence hodnoty na entitě budou prohledáváni
předci).
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
groupRoleId |
EosIdentifier |
Ano |
Id požadované skupinové role |
attrId |
EosIdentifier |
Ano |
Id hledaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v groupRoleId nebo attrId |
Výstup
Výjimky
Načte seznam hodnot atributů dané aplikace v konkrétní skupinové roli.
Zároveň načte hodnoty z předků.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
appId |
EosIdentifier |
Ano |
Id požadované aplikace |
groupRoleId |
EosIdentifier |
Ano |
Id konkrétní skupinové role |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v groupRoleId nebo appId |
Výstup
Výjimky
Načte hodnotu atributu v dané organizační roli. Dědičnost hodnot NENÍ
brána v potaz (v případě neexistence hodnoty na entitě NEbudou
prohledáváni předci).
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
unitId |
EosIdentifier |
Ano |
Id požadované organizační role |
attrId |
EosIdentifier |
Ano |
Id hledaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v orgUnitId nebo attrId |
Výstup
Výjimky
Načte hodnoty atributu v dané organizační roli. Dědičnost hodnot je brána
v potaz (v případě neexistence hodnoty na entitě budou prohledáváni
předci).
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
orgRoleId |
EosIdentifier |
Ano |
Id požadované organizační role |
attrId |
EosIdentifier |
Ano |
Id hledaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v orgRoleId nebo attrId |
Výstup
Výjimky
Načte seznam hodnot atributů dané aplikace v konkrétní organizační roli.
Zároveň načte hodnoty z předků.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
appId |
EosIdentifier |
Ano |
Id požadované aplikace |
orgRoleId |
EosIdentifier |
Ano |
Id konkrétní organizační role |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v orgRoleId nebo appId |
Výstup
Výjimky
Načte hodnotu atributu v dané organizační jednotce. Dědičnost hodnot NENÍ
brána v potaz (v případě neexistence hodnoty na entitě NEbudou
prohledáváni předci).
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
unitId |
EosIdentifier |
Ano |
Id požadované entity |
attrId |
EosIdentifier |
Ano |
Id hledaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v orgUnitId nebo attrId |
Výstup
Výjimky
Načte hodnoty atributu v dané organizační jednotce. Dědičnost hodnot je
brána v potaz (v případě neexistence hodnoty na entitě budou prohledáváni
předci).
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
unitId |
EosIdentifier |
Ano |
Id požadované organizační jednotky |
attrId |
EosIdentifier |
Ano |
Id hledaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v orgUnitId nebo attrId |
Výstup
Výjimky
Načte seznam hodnot atributů dané aplikace v konkrétní organizační
jednotce. Zároveň načte hodnoty z předků.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
appId |
EosIdentifier |
Ano |
Id požadované aplikace |
unitId |
EosIdentifier |
Ano |
Id konkrétní organizační jednotky |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v orgUnitId nebo appId |
Výstup
Výjimky
Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní skupinové
role včetně hodnot přiřazených na osobě.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
groupRoleId |
EosIdentifier |
Ano |
Id požadované skupinové role |
appId |
EosIdentifier |
Ano |
Id aplikace |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId, orgUnitId nebo appId |
Výstup
Výjimky
Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní skupinové
role vyjma hodnot přiřazených na osobě.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
groupRoleId |
EosIdentifier |
Ano |
Id požadované skupinové role |
appId |
EosIdentifier |
Ano |
Id aplikace |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId, orgUnitId nebo appId |
Výstup
Výjimky
Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní
organizační role včetně hodnot přiřazených na osobě.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
orgRoleId |
EosIdentifier |
Ano |
Id požadované organizační role |
appId |
EosIdentifier |
Ano |
Id aplikace |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId, orgUnitId nebo appId |
Výstup
Výjimky
Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní
organizační role vyjma hodnot přiřazených na osobě.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
orgRoleId |
EosIdentifier |
Ano |
Id požadované organizační role |
appId |
EosIdentifier |
Ano |
Id aplikace |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId, orgUnitId nebo appId |
Výstup
Výjimky
Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní
organizační jednotky včetně hodnot přiřazených na osobě.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
unitId |
EosIdentifier |
Ano |
Id požadované organizační jednotky |
appId |
EosIdentifier |
Ano |
Id aplikace |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId, orgUnitId nebo appId |
Výstup
Výjimky
Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní
organizační jednotky vyjma hodnot přiřazených na osobě.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id požadované osoby |
unitId |
EosIdentifier |
Ano |
Id požadované organizační jednotky |
appId |
EosIdentifier |
Ano |
Id aplikace |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId, orgUnitId nebo appId |
Výstup
Výjimky
Zjištění hodnoty atributů daného uživatele. Načte všechny výskyty
atributů v organizačních jednotkách, rolích a u osoby, na cestě směrem ke
kořenovému uzlu, prohledá zadanou aplikaci.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
Id osoby, pro kterou se provádí prohledávání |
appId |
EosIdentifier |
Ano |
Id aplikace, pro kterou se mají atributy nalézt |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v personId nebo appId |
Výstup
EosAttributeValues - atribut nalezený na větvi stromu, null pokud nebyl nalezen žádný
výskyt
Výjimky
Najde selektový atribut daného Id.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
attrId |
EosIdentifier |
Ano |
Id požadovaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v attrId |
Výstup
Výjimky
Najde stringový atribut daného Id.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
attrId |
EosIdentifier |
Ano |
Id požadovaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v attrId |
Výstup
Výjimky
Najde WS atribut daného Id.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
attrId |
EosIdentifier |
Ano |
Id požadovaného atributu |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id
v attrId |
Výstup
Výjimky
Reprezentuje wrapper pro kolekci hodnot různých atributů.
Seznam hodnot různých atributů.
Reprezentuje wrapper pro kolekci různých atributů.
Reprezentuje boolean atribut.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
name |
String (255) |
Ano |
Jméno atributu. |
description |
String (2048) |
Ne |
Popis atributu. |
displayName |
String (256) |
Ano |
Zobrazované jméno. |
inheritable |
Boolean |
Ano |
Příznak, zda se mají hodnoty atributu dědit. |
defaultValue |
Boolean |
Ano |
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. |
Reprezentuje hodnotu boolean atributu.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
name |
String (255) |
Ano |
Jméno atributu. |
description |
String (2048) |
Ne |
Popis atributu. |
displayName |
String (256) |
Ano |
Zobrazované jméno. |
inheritable |
Boolean |
Ano |
Příznak, zda se mají hodnoty atributu dědit. |
value |
EosBooleanValue |
Ne |
Přiřazená hodnota atributu. |
Reprezentuje hodnotu boolean atributu.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
content |
Boolean |
Ne |
Samotná hodnota atributu. |
comment |
String (512) |
Ne |
Komentář hodnoty atributu. |
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 výčtový atribut.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
name |
String (255) |
Ano |
Jméno atributu. |
description |
String (2048) |
Ne |
Popis atributu. |
displayName |
String (256) |
Ano |
Zobrazované jméno. |
inheritable |
Boolean |
Ano |
Příznak, zda se mají hodnoty atributu dědit. |
validClass |
String (512) |
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 (512) |
Ne |
Výchozí hodnota výčtového atributu. |
singleValue |
Boolean |
Ano |
Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový. |
rangeValues |
EosRangeValues |
Ano |
Výčet hodnot. |
Reprezentuje přiřazené hodnoty enum atributu.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
name |
String (255) |
Ano |
Jméno atributu. |
description |
String (2048) |
Ne |
Popis atributu. |
displayName |
String (256) |
Ano |
Zobrazované jméno. |
inheritable |
Boolean |
Ano |
Příznak, zda se mají hodnoty atributu dědit. |
values |
EosValues |
Ne |
Přiřazené hodnoty výčtovému atributu. |
Reprezentuje hodnotu oboru hodnot nějakého externího atributu, tedy například
selektového nebo WS atributu.
Jméno atributu |
Datový typ |
Povinné |
Popis |
content |
String (512) |
Ano |
Samotná hodnota atributu. |
comment |
String (512) |
Ne |
Komentář hodnoty atributu. |
externId |
String |
Ne |
Externí ID hodnoty oboru hodnot. |
Reprezentuje wrapper pro obor hodnot externího atributu.
Jméno atributu |
Datový typ |
Povinné |
Popis |
value |
List<EosExternRangeValue> |
Ne |
Kolekce hodnot oboru. |
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. |
Reprezentuje hodnotu oboru hodnot výčtového atributu.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
content |
String (512) |
Ano |
Samotná hodnota atributu. |
comment |
String (512) |
Ne |
Komentář hodnoty atributu. |
weight |
Integer |
Ano |
Určuje váhu hodnoty atributu. |
Reprezentuje wrapper pro obor hodnot enum atributu.
Jméno atributu |
Datový typ |
Povinné |
Popis |
value |
List<EosRangeValue> |
Ne |
Kolekce hodnot oboru. |
Reprezentuje selektový atribut.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
name |
String (255) |
Ano |
Jméno atributu. |
description |
String (2048) |
Ne |
Popis atributu. |
displayName |
String (256) |
Ano |
Zobrazované jméno. |
inheritable |
Boolean |
Ano |
Příznak, zda se mají hodnoty atributu dědit. |
validClass |
String (512) |
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 (4000) |
Ano |
Select příkaz pro dotaz do číselníku. Pro atributy,
jejichž hodnoty odpovídají řádkům z číselníku. (SQL výsledku). |
sqlColumn |
String (32) |
Ano |
Jméno sloupce z SQL dotazu (sqlCommand), který se má vzít jako obor hodnot. |
sqlKeyColumn |
String (256) |
Ano |
Jméno sloupce z SQL dotazu (sqlCommand), který obsahuje jednoznačnou
identifikaci (ID) hodnot. |
sqlTreeKey |
String (256) |
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 (256) |
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. |
sqlClass |
String (32) |
Ne |
Jméno sloupce z SQL dotazu (sqlCommand), který obsahuje třídu (typ dané
hodnoty). Pokud je null, není brán v potaz. |
sqlDescription |
String (32) |
Ne |
Název sloupce pro popis hodnoty. |
dbConnection |
EosDbConnection |
Ne |
Připojení k databázi. |
Reprezentuje stringový atribut.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
name |
String (255) |
Ano |
Jméno atributu. |
description |
String (2048) |
Ne |
Popis atributu. |
displayName |
String (256) |
Ano |
Zobrazované jméno. |
inheritable |
Boolean |
Ano |
Příznak, zda se mají hodnoty atributu dědit. |
regExp |
String (512) |
Ne |
Regulární výraz, jemuž musí odpovídat nastavovaná hodnota. Pokud je null
validace se neprovádí. |
regExpDescription |
String (256) |
Ne |
Komentář regulárního výrazu - zobrazuje se uživateli. |
defaultValue |
String (512) |
Ne |
Výchozí hodnota atributu. |
singleValue |
Boolean |
Ano |
Pokud je true, atribut nese právě 1 hodnotu, jinak je vícehodnotový. |
conflictValue |
String (512) |
Ne |
Hodnota, která se má použít, pokud při výpočtu dojde ke konfliktu. |
Reprezentuje hodnotu stringového atributu.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
name |
String (255) |
Ano |
Jméno atributu. |
description |
String (2048) |
Ne |
Popis atributu. |
displayName |
String (256) |
Ano |
Zobrazované jméno. |
inheritable |
Boolean |
Ano |
Příznak, zda se mají hodnoty atributu dědit. |
value |
EosValue |
Ne |
Přiřazená hodnota stringovému atributu. |
Reprezentuje hodnotu string atributu, výčtového atributu a selectového
atributu. Dále pak hodnoty rozsahu výčtového atributu.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
content |
String (512) |
Ano |
Samotná hodnota atributu. |
comment |
String (512) |
Ne |
Komentář hodnoty atributu. |
Reprezentuje wrapper pro kolekci stringových hodnot atributů.
Jméno atributu |
Datový typ |
Povinné |
Popis |
value |
List<EosValue> |
Ne |
Kolekce aplikací. |
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
name |
String (255) |
Ano |
Jméno atributu. |
description |
String (2048) |
Ne |
Popis atributu. |
displayName |
String (256) |
Ano |
Zobrazované jméno. |
inheritable |
Boolean |
Ano |
Příznak, zda se mají hodnoty atributu dědit. |
validClass |
String (512) |
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 (255) |
Ano |
URL webové služby, ze které bude načítán obor hodnot. |