# 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.

## Obsah

- Obecné informace
- Seznam poskytovaných metod
- Seznam struktur dat
- Výjimky
- Popis poskytovaných metod
- Popis struktur dat

## Obecné informace

Rozhraní webové služby pro čtení informací o atributech. Čte vždy jen neskryté atributy.

## Seznam poskytovaných metod

Název | Popis
--- | ---
getAppAttributes | Vrátí atributy aplikace.
getAttributeByName | Najde atribut předané aplikace s požadovaným jménem.
getAttributeExternRange | Načte obor hodnot konkrétního obecného výčtového atributu s externími hodnotami, tedy selektového nebo WS atributu.
getBooleanAttributeById | Najde boolean atribut daného Id.
getEnumAttributeById | Najde výčtový atribut daného Id.
getGroupRoleDirectValue | Načte hodnotu atributu v dané skupinové roli.
getGroupRoleValue | Načte hodnoty atributu v dané skupinové roli.
getGroupRoleValues | Načte seznam hodnot atributů dané aplikace v konkrétní skupinové roli.
getOrgRoleDirectValue | Načte hodnotu atributu v dané organizační roli.
getOrgRoleValue | Načte hodnoty atributu v dané organizační roli.
getOrgRoleValues | Načte seznam hodnot atributů dané aplikace v konkrétní organizační roli.
getOrgUnitDirectValue | Načte hodnotu atributu v dané organizační jednotce.
getOrgUnitValue | Načte hodnoty atributu v dané organizační jednotce.
getOrgUnitValues | Načte seznam hodnot atributů dané aplikace v konkrétní organizační jednotce.
getPersonGroupRoleAssignmentValues | Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní skupinové role včetně hodnot přiřazených na osobě.
getPersonGroupRoleOnlyAssignmentValues | Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní skupinové role vyjma hodnot přiřazených na osobě.
getPersonOrgRoleAssignmentValues | Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní organizační role včetně hodnot přiřazených na osobě.
getPersonOrgRoleOnlyAssignmentValues | Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní organizační role vyjma hodnot přiřazených na osobě.
getPersonOrgUnitAssignmentValues | Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní organizační jednotky včetně hodnot přiřazených na osobě.
getPersonOrgUnitOnlyAssignmentValues | Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní organizační jednotky vyjma hodnot přiřazených na osobě.
getPersonValues | Zjištění hodnoty atributů daného uživatele.
getSelectAttributeById | Najde selektový atribut daného Id.
getStringAttributeById | Najde stringový atribut daného Id.
getWSAttributeById | Najde WS atribut daného Id.

## Seznam struktur dat

Název | Popis
--- | ---
EosAttributeValues | Reprezentuje wrapper pro kolekci hodnot různých atributů.
EosAttributes | Reprezentuje wrapper pro kolekci různých atributů.
EosBooleanAttribute | Reprezentuje boolean atribut.
EosBooleanAttributeValue | Reprezentuje hodnotu boolean atributu.
EosBooleanValue | Reprezentuje hodnotu boolean atributu.
EosDatabaseType | Výčet typů databázových serverů.
EosDbConnection | Reprezentuje databázové připojení.
EosEnumAttribute | Reprezentuje výčtový atribut.
EosEnumAttributeValue | Reprezentuje přiřazené hodnoty enum atributu.
EosExternRangeValue | Reprezentuje hodnotu oboru hodnot nějakého externího atributu, tedy například selektového nebo WS atributu.
EosExternRangeValues | Reprezentuje wrapper pro obor hodnot externího atributu.
EosIdentifier | Reprezentuje identifikátor webového objektu slučující interní a externí ID.
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.
EosStringAttributeValue | Reprezentuje hodnotu stringového atributu.
EosValue | Reprezentuje hodnotu string atributu, výčtového atributu a selectového atributu.
EosValues | Reprezentuje wrapper pro kolekci stringových hodnot atributů.
EosWsAttribute | Reprezentuje WS atribut.

## Výjimky

### EosInvalidParameterException

Vyjímka reprezentuje špatný vstupní parametr do web metod.

### EosObjectNotFoundException

Vyjímka reprezentuje stav, kdy nebyl objekt podle kriterií nalezen.

### EosOrgStructureException

Vyjímka reprezentuje stav, kdy došlo k problému při práci s organizační strukturou.

### EosPersonNotAssignedException

Reprezentuje stav, kdy osoba není zařazená do očekávané entity (jednotková role nebo organizační jednotka).

### EosRangeValueException

Vyjímka reprezentuje chybu získávání range values.

### EosUnexpectedException

Reprezentuje neočekávanou výjimku při volání WS. Jejím zdrojem musí být vždy jiná výjimka.

## Popis poskytovaných metod

### getAppAttributes

Vrátí atributy aplikace.

#### Předpis

EosAttributes getAppAttributes (EosIdentifier appId, String clientId)

#### 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

EosAttributes - neskryté atributy.

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getAttributeByName

Najde atribut předané aplikace s požadovaným jménem.

#### Předpis

EosAttributes getAttributeByName (EosIdentifier appId, String name, String clientId)

#### 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

EosAttributes - nalezený atribut

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getAttributeExternRange

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

EosExternRangeValues getAttributeExternRange (EosIdentifier attrId, String clientId)

#### 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

EosExternRangeValues - seřazený seznam (od nejvyšší váhy) možných hodnot atributu

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - při předání neplatného ID nebo ID nesprávného typu atributu
EosRangeValueException - chyba při načítání seznamu hodnot
EosUnexpectedException - nastala vnitřní chyba EOSu

### getBooleanAttributeById

Najde boolean atribut daného Id.

#### Předpis

EosBooleanAttribute getBooleanAttributeById (EosIdentifier attrId, String clientId)

#### 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

EosBooleanAttribute - boolean atribut

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getEnumAttributeById

Najde výčtový atribut daného Id.

#### Předpis

EosEnumAttribute getEnumAttributeById (EosIdentifier attrId, String clientId)

#### 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

EosEnumAttribute - výčtový atribut

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getGroupRoleDirectValue

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

EosAttributeValues getGroupRoleDirectValue (EosIdentifier unitId, EosIdentifier attrId, String clientId)

#### 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

EosAttributeValues - hodnotu atributu

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getGroupRoleValue

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

EosAttributeValues getGroupRoleValue (EosIdentifier groupRoleId, EosIdentifier attrId, String clientId)

#### 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

EosAttributeValues - hodnotu atributu

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getGroupRoleValues

Načte seznam hodnot atributů dané aplikace v konkrétní skupinové roli. Zároveň načte hodnoty z předků.

#### Předpis

EosAttributeValues getGroupRoleValues (EosIdentifier appId, EosIdentifier groupRoleId, String clientId)

#### 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

EosAttributeValues - seznam hodnot atributů

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getOrgRoleDirectValue

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

EosAttributeValues getOrgRoleDirectValue (EosIdentifier unitId, EosIdentifier attrId, String clientId)

#### 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

EosAttributeValues - hodnotu atributu

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getOrgRoleValue

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

EosAttributeValues getOrgRoleValue (EosIdentifier orgRoleId, EosIdentifier attrId, String clientId)

#### 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

EosAttributeValues - hodnotu atributu

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getOrgRoleValues

Načte seznam hodnot atributů dané aplikace v konkrétní organizační roli. Zároveň načte hodnoty z předků.

#### Předpis

EosAttributeValues getOrgRoleValues (EosIdentifier appId, EosIdentifier orgRoleId, String clientId)

#### 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

EosAttributeValues - seznam hodnot atributů

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getOrgUnitDirectValue

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

EosAttributeValues getOrgUnitDirectValue (EosIdentifier unitId, EosIdentifier attrId, String clientId)

#### 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

EosAttributeValues - hodnotu atributu

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getOrgUnitValue

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

EosAttributeValues getOrgUnitValue (EosIdentifier unitId, EosIdentifier attrId, String clientId)

#### 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

EosAttributeValues - hodnotu atributu

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getOrgUnitValues

Načte seznam hodnot atributů dané aplikace v konkrétní organizační jednotce. Zároveň načte hodnoty z předků.

#### Předpis

EosAttributeValues getOrgUnitValues (EosIdentifier appId, EosIdentifier unitId, String clientId)

#### 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

EosAttributeValues - seznam hodnot atributů

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getPersonGroupRoleAssignmentValues

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

EosAttributeValues getPersonGroupRoleAssignmentValues (EosIdentifier personId, EosIdentifier groupRoleId, EosIdentifier appId, String clientId)

#### 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

EosAttributeValues - hodnoty atributů aplikace na zařazení osoby

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosPersonNotAssignedException - osoba není zařazená v předané entitě
EosUnexpectedException - nastala vnitřní chyba EOSu

### getPersonGroupRoleOnlyAssignmentValues

Načte hodnoty atributů aplikace pro zařazení osoby do konkrétní skupinové role vyjma hodnot přiřazených na osobě.

#### Předpis

EosAttributeValues getPersonGroupRoleOnlyAssignmentValues (EosIdentifier personId, EosIdentifier groupRoleId, EosIdentifier appId, String clientId)

#### 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

EosAttributeValues - hodnoty atributů aplikace na zařazení osoby

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosOrgStructureException - při chybě v organizační struktuře
EosPersonNotAssignedException - osoba není zařazená v předané entitě
EosUnexpectedException - nastala vnitřní chyba EOSu
EosInvalidParameterException - při předání neplatných dat

### getPersonOrgRoleAssignmentValues

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

EosAttributeValues getPersonOrgRoleAssignmentValues (EosIdentifier personId, EosIdentifier orgRoleId, EosIdentifier appId, String clientId)

#### 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

EosAttributeValues - hodnoty atributů aplikace na zařazení osoby

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosPersonNotAssignedException - osoba není zařazená v předané entitě
EosUnexpectedException - nastala vnitřní chyba EOSu

### getPersonOrgRoleOnlyAssignmentValues

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

EosAttributeValues getPersonOrgRoleOnlyAssignmentValues (EosIdentifier personId, EosIdentifier orgRoleId, EosIdentifier appId, String clientId)

#### 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

EosAttributeValues - hodnoty atributů aplikace na zařazení osoby

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosOrgStructureException - při chybě v organizační struktuře
EosPersonNotAssignedException - osoba není zařazená v předané entitě
EosUnexpectedException - nastala vnitřní chyba EOSu
EosInvalidParameterException - při předání neplatných dat

### getPersonOrgUnitAssignmentValues

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

EosAttributeValues getPersonOrgUnitAssignmentValues (EosIdentifier personId, EosIdentifier unitId, EosIdentifier appId, String clientId)

#### 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

EosAttributeValues - hodnoty atributů aplikace na zařazení osoby

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosPersonNotAssignedException - osoba není zařazená v předané entitě
EosUnexpectedException - nastala vnitřní chyba EOSu

### getPersonOrgUnitOnlyAssignmentValues

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

EosAttributeValues getPersonOrgUnitOnlyAssignmentValues (EosIdentifier personId, EosIdentifier unitId, EosIdentifier appId, String clientId)

#### 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

EosAttributeValues - hodnoty atributů aplikace na zařazení osoby

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosPersonNotAssignedException - osoba není zařazená v předané entitě
EosUnexpectedException - nastala vnitřní chyba EOSu

### getPersonValues

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

EosAttributeValues getPersonValues (EosIdentifier personId, EosIdentifier appId, String clientId)

#### 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

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu
EosOrgStructureException - při nalezení duplicitní personální role

### getSelectAttributeById

Najde selektový atribut daného Id.

#### Předpis

EosSelectAttribute getSelectAttributeById (EosIdentifier attrId, String clientId)

#### 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

EosSelectAttribute - selektový atribut

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getStringAttributeById

Najde stringový atribut daného Id.

#### Předpis

EosStringAttribute getStringAttributeById (EosIdentifier attrId, String clientId)

#### 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

EosStringAttribute - stringový atribut

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

### getWSAttributeById

Najde WS atribut daného Id.

#### Předpis

EosWsAttribute getWSAttributeById (EosIdentifier attrId, String clientId)

#### 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

EosWsAttribute - WS atribut

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

## Popis struktur dat

### EosAttributeValues

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

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
booleanAttributeValue | List<EosBooleanAttributeValue> | Ne | Hodnoty boolean atributů.
enumAttributeValue | List<EosEnumAttributeValue> | Ne | Hodnoty výčtových atributů.
selectAttributeValue | List<EosEnumAttributeValue> | Ne | Hodnoty selektových atributů.
stringAttributeValue | List<EosStringAttributeValue> | Ne | Hodnoty stringových atributů.
wsAttributeValue | List<EosEnumAttributeValue> | Ne | Hodnoty WS atributů.

### EosAttributes

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

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
booleanAttribute | List<EosBooleanAttribute> | Ne | Kolekce boolean atributů.
enumAttribute | List<EosEnumAttribute> | Ne | Kolekce výčtových atributů.
selectAttribute | List<EosSelectAttribute> | Ne | Kolekce selektových atributů.
stringAttribute | List<EosStringAttribute> | Ne | Kolekce stringových atributů.
wsAttribute | List<EosWsAttribute> | Ne | Kolekce WS atributů.

### EosBooleanAttribute

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.

### EosBooleanAttributeValue

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.

### EosBooleanValue

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.

### EosDatabaseType

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

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

### EosDbConnection

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.

### EosEnumAttribute

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.

### EosEnumAttributeValue

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.

### EosExternRangeValue

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.

### EosExternRangeValues

Reprezentuje wrapper pro obor hodnot externího atributu.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
value | List<EosExternRangeValue> | Ne | Kolekce hodnot oboru.

### EosIdentifier

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.

### EosRangeValue

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.

### EosRangeValues

Reprezentuje wrapper pro obor hodnot enum atributu.

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

### EosSelectAttribute

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.

### EosStringAttribute

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.

### EosStringAttributeValue

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.

### EosValue

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.

### EosValues

Reprezentuje wrapper pro kolekci stringových hodnot atributů.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
value | List<EosValue> | Ne | Kolekce aplikací.

### EosWsAttribute

Reprezentuje WS 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.
url | String (255) | Ano | URL webové služby, ze které bude načítán obor hodnot.