Webová služba AttributeRead verze 2.1.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í webové služby pro čtení informací o atributech. Čte vždy jen neskryté atributy.

Od EOS verze 4-12.1 je pro interní EOS atribut stejné chování a jsou používány stejné metody jako pro select. V příští verzi webových služeb bude mít vnitřní atribut již vlastní struktury a metody. Podpora pro vnitřní atribut je u jednotlivých metod označena.


Seznam poskytovaných metod

Název Popis
getPersonApplicationInfo Načtení informací o osobě, aplikaci, zařazení osoby do organizační struktury a hodnotách oprávnění.
getPersonApplicationInfoAsXml Načtení informací o osobě, aplikaci, zařazení osoby do organizační struktury a hodnotách oprávnění.
getPersonValuesByAppId Zjištění hodnoty atributů daného uživatele.
getPersonValuesByStr Zjištění hodnoty atributů daného uživatele.

Seznam struktur dat

Název Popis
EosApplication Reprezentuje aplikaci.
EosApplicationContainer Reprezentuje kontejner aplikace.
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.
EosBuildingInfo Reprezentuje údaje o budově.
EosContactType Reprezentuje typ kontaktního atributu.
EosContactTypeCategory Reprezentuje kategorii typu kontaktního atributu.
EosContacts Reprezentuje wrapper pro kolekci telefonů.
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.
EosIdentifier Reprezentuje identifikátor webového objektu slučující interní a externí ID.
EosOrgRole Reprezentuje organizační roli.
EosOrgUnit Reprezentuje organizační jednotku.
EosOrgUnits Reprezentuje wrapper pro kolekci organizačních jednotek.
EosOtherContact Reprezentuje telefoní kontakt.
EosPerson Reprezentuje osobu.
EosPersonAssignmentInfo Reprezentuje doplňující informace o konkrétním zařazení osoby.
EosPersonContainer Kontejner sloužící pro vrácení osoby společně s jejím primárním zařazením.
EosPersonPrimaryLocation Reprezentuje primární zařazení osoby.
EosPhoneContact Reprezentuje telefoní kontakt.
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.
EosUserField Reprezentuje uživatelské pole.
EosUserFields Reprezentuje kolekci uživatelských polí.
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.
PersonApplicationInfo Objekt reprezentující informace o osobě a aplikaci.

Výjimky

EosInvalidParameterException

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

EosNoPrimaryAssignmentException

Vyjímka reprezentuje stav, kdy neexistuje primarni zarazeni osoby.

EosObjectNotFoundException

Výjimka 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).

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

getPersonApplicationInfo

Načtení informací o osobě, aplikaci, zařazení osoby do organizační struktury a hodnotách oprávnění.

Přidána podpora pro vnitřní atribut.

Předpis

PersonApplicationInfo getPersonApplicationInfo (EosIdentifier personId, EosIdentifier appId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano id osoby
appId EosIdentifier Ano id aplikace
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId

Výstup

PersonApplicationInfo - objekt s informacemi

Výjimky

EosObjectNotFoundException - osoba s daným id nebyla nalezena
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosPersonNotAssignedException - osoba není nikam zařazená
EosNoPrimaryAssignmentException - osoba nemá primární zařazení
EosUnexpectedException - vnitřní chyba EOSu

getPersonApplicationInfoAsXml

Načtení informací o osobě, aplikaci, zařazení osoby do organizační struktury a hodnotách oprávnění.

Přidána podpora pro vnitřní atribut.

Předpis

String getPersonApplicationInfoAsXml (EosIdentifier personId, EosIdentifier appId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano id osoby
appId EosIdentifier Ano id aplikace
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId

Výstup

String - objekt s informacemi

Výjimky

EosObjectNotFoundException - osoba s daným id nebyla nalezena
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosPersonNotAssignedException - osoba není nikam zařazená
EosNoPrimaryAssignmentException - osoba nemá primární zařazení
EosUnexpectedException - vnitřní chyba EOSu

getPersonValuesByAppId

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řidána podpora pro vnitřní atribut.

Předpis

EosAttributeValues getPersonValuesByAppId (String userName, String applicationId)

Parametry

Parametr Typ Povinný Popis
userName String Ano uživatelské jméno osoby, pro kterou se provádí prohledávání
applicationId String Ano id aplikace, pro kterou se mají atributy nalézt

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

getPersonValuesByStr

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řidána podpora pro vnitřní atribut.

Předpis

EosAttributeValues getPersonValuesByStr (String userName, String appName)

Parametry

Parametr Typ Povinný Popis
userName String Ano uživatelské jméno osoby, pro kterou se provádí prohledávání
appName String Ano název aplikace, pro kterou se mají atributy nalézt

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

Popis struktur dat

EosApplication

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.

EosApplicationContainer

Reprezentuje kontejner aplikace. Obsahuje samotnou aplikaci a její atributy.

Jméno atributu Datový typ Povinné Popis
application EosApplication Ano Aplikace.
attributes EosAttributes Ano Atributy.

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.
guidEos3 String Ne guid pro tridu {@link AttributeEos3} XML elementu EOS_Atribut.
guidColumnEos3 String Ne guid pro tridu {@link AttributeColumnEos3} XML elementu EOS_Sloupec_Atribut.
guidValueEos3 String Ne Seznam z dvou guid pro tridu {@link AttributeValueEos3} oddelenych pres "|" XML elementu EOS_Atribut_Hodnota pro hodnoty "Ano" a "Ne".
guidColumnValueEos3 String Ne Seznam z dvou guid pro tridu {@link ColumnValueEos3} oddelenych pres "|" XML elementu EOS_Sloupec_Hodnota pro hodnoty "Ano" a "Ne".

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.

EosBuildingInfo

Reprezentuje údaje o budově. Není v EOSu skutečnou entitou, proto neobsahuje žádný identifikátor.

Jméno atributu Datový typ Povinné Popis
building EosValue Ne Název budovy.
floor EosValue Ne Patro budovy.
room EosValue Ne Místnost budovy.
externalRegistryId EosValue Ne Odkaz na externi id registru budov.

EosContactType

Reprezentuje typ kontaktního atributu.
Hodnota Popis
PHONE Telefon.
FAX Fax.
EMAIL Email.
WWW WWW.

EosContactTypeCategory

Reprezentuje kategorii typu kontaktního atributu.
Hodnota Popis
HOME Domů.
WORK Do práce.
MOBILE Mobilní.
BLANK Bez kategorie.

EosContacts

Reprezentuje wrapper pro kolekci telefonů.

Jméno atributu Datový typ Povinné Popis
phoneContact List<EosPhoneContact> Ne Kolekce telefonů(fax, mobil, ...).
otherContact List<EosOtherContact> Ne Kolekce ostatních kontaktů(email, www, ...).

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.
guidEos3 String Ne guid pro tridu {@link AttributeEos3} XML elementu EOS_Atribut.
guidColumnEos3 String Ne guid pro tridu {@link AttributeColumnEos3} XML elementu EOS_Sloupec_Atribut.

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.

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.

EosOrgRole

Reprezentuje organizační roli.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
buildingInfo EosBuildingInfo Ne Informace o budově.
userFields EosUserFields Ne Uživatelská pole jednotlivých entit.
phones EosContacts Ne Telefony přiřazené této entitě.
name String (255) Ano Jméno organizační role.
code String (100) Ne Kód organizační role.
sentence Integer Ne Pořadí pracovní pozice v rámci nadřízené organizační jednotky.
altName String Ne Alternativní název role.
unitId EosIdentifier Ano Organizační jednotka, do které je role zařazena.
superiorId EosIdentifier Ne Nadřazená organizační role.
typeCode String (32) Ne Kód typu organizační role.

EosOrgUnit

Reprezentuje organizační jednotku.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
buildingInfo EosBuildingInfo Ne Informace o budově.
userFields EosUserFields Ne Uživatelská pole jednotlivých entit.
phones EosContacts Ne Telefony přiřazené této entitě.
name String (255) Ano Jméno organizační jednotky.
code String (100) Ne Kód organizační jednotky.
parentId EosIdentifier Ne Externí id nadřízené organizační jednotky.
altName String (255) Ne Alternativní název organizační jednotky.
description String (255) Ne Popis organizační jednotky.
abbrev String (25) Ne Zkratka organizační jednotky.
typeCode String (32) Ne Kód typu organizační jednotky.
sentence Integer Ne Pořadí organizační jednotky v rámci nadřízené organizační jednotky.

EosOrgUnits

Reprezentuje wrapper pro kolekci organizačních jednotek.

Jméno atributu Datový typ Povinné Popis
units List<EosOrgUnit> Ne Kolekce organizačních jednotek.

EosOtherContact

Reprezentuje telefoní kontakt.
Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
description String (512) Ne Popis telefonu.
contactType EosContactType Ne Typ kontaktu.
contactTypeCategory EosContactTypeCategory Ne Kategorie typu kontaktu.
contact EosIdentifier Ne Id atributu kontaktu.
primary boolean Ne Určuje zda je kontakt primární.
publicable boolean Ne Určuje zda je kontakt veřejný.
value String (80) Ne Linka.

EosPerson

Reprezentuje osobu.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
surname1 String (64) Ano 1. příjmení.
surname2 String (64) Ne 2. příjmení.
firstname1 String (64) Ano 1. křestní jméno.
firstname2 String (64) Ne 2. křestní jméno.
degreeBefore String (32) Ne Akademický titul před jménem.
degreeAfter String (32) Ne Akademický titul za jménem.
dateStart Date Ne Datum zavedení do evidence.
dateEnd Date Ne Datum vyřazení z evidence.
username String (255) Ne Uživatelské jméno. Není povinné kvůli tomu, že je možné jméno generovat.
abbrev String (24) Ne Zkratka.
email String (128) Ne Adresa elektronické pošty. Pokud je uvedena, je unikátní. Nevyplněná hodnota je dovolena u více uživatelů.
displayName String (255) Ne Zobrazované jméno.
personalNumber String (255) Ne Osobní číslo.

EosPersonAssignmentInfo

Reprezentuje doplňující informace o konkrétním zařazení osoby.
Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
buildingInfo EosBuildingInfo Ne Informace o budově.
userFields EosUserFields Ne Uživatelská pole jednotlivých entit.
phones EosContacts Ne Telefony přiřazené této entitě.
degree Integer Ne Úroveň obsazení osoby do role - zastupitelnost, asistence apod.
capacity Integer Ne Odpovídá pracovní kapacitě jež daný pracovník věnuje konkrétní roli. Doporučeno, aby číslo odpovídalo procentuelnímu vyjádření.
fromDate Date Ne Datum, od kterého (včetně) je daná osoba obsazena.
toDate Date Ne Datum, do kterého (včetně) je daná osoba obsazena.

EosPersonContainer

Kontejner sloužící pro vrácení osoby společně s jejím primárním zařazením.

Jméno atributu Datový typ Povinné Popis
person EosPerson Ano Osoba.
primaryAssignment EosPersonPrimaryLocation Ne Primární zařazení osoby.

EosPersonPrimaryLocation

Reprezentuje primární zařazení osoby. Nese informace o roli, ve které je osoba primárně zařazena a o rganizační jednotce, ve které je tato role.

Jméno atributu Datový typ Povinné Popis
roleName String (255) Ano Jméno organizační role.
roleIdentifier EosIdentifier Ano Identifier organizační role.
orgUnitName String Ano Jméno organizační jednotky.
orgUnitIdentifier EosIdentifier Ano Identifier organizační jednotky.

EosPhoneContact

Reprezentuje telefoní kontakt.
Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
description String (512) Ne Popis telefonu.
contactType EosContactType Ne Typ kontaktu.
contactTypeCategory EosContactTypeCategory Ne Kategorie typu kontaktu.
contact EosIdentifier Ne Id atributu kontaktu.
primary boolean Ne Určuje zda je kontakt primární.
publicable boolean Ne Určuje zda je kontakt veřejný.
prefix String (80) Ne Předvolba.
number String (80) Ano Telefonní číslo.
extension String (80) Ne Linka.

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.
guidValueEos3 String Ne guid pro tridu {@link AttributeValueEos3} XML elementu EOS_Atribut_Hodnota.
guidColumnValueEos3 String Ne guid pro tridu {@link ColumnValueEos3} XML elementu EOS_Sloupec_Hodnota.

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.
guidEos3 String Ne guid pro tridu {@link AttributeEos3} XML elementu EOS_Atribut.
guidColumnEos3 String Ne guid pro tridu {@link AttributeColumnEos3} XML elementu EOS_Sloupec_Atribut.

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.

EosUserField

Reprezentuje uživatelské pole.

Jméno atributu Datový typ Povinné Popis
name String (255) Ano Jméno uživatelského pole.
content String (512) Ano Hodnota uživatelského pole.
code String (255) Ano Kód uživatelského pole.

EosUserFields

Reprezentuje kolekci uživatelských polí.

Jméno atributu Datový typ Povinné Popis
userField List<EosUserField> Ne Kolekce uživatelských polí.

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) Ne URL webové služby, ze které bude načítán obor hodnot.
username String (255) Ne Uživatelské jméno.
password String (255) Ne Uživatelské jméno.
treeAttribute Boolean Ne Uživatelské jméno.
urlRelative Boolean Ne Uživatelské jméno.
script String (32768) Ne Skript pro načtení hodnot z WS.
additionScript String (32768) Ne DOdatečný skript pro načtení plochého seznamu hodnot u stromového atributu .

PersonApplicationInfo

Objekt reprezentující informace o osobě a aplikaci. Obsahuje informace o primárním zařazení osoby a oprávněních pro danou aplikaci. K osobě jsou vráceny informace o uživatelských polích, kontaktech a pracovišti.

Jméno atributu Datový typ Povinné Popis
applicationContainer EosApplicationContainer Ano Předpis aplikace a atributů.
personAssignmentInfo EosPersonAssignmentInfo Ano Informace o primárním zařazení osoby do role.
personContainer EosPersonContainer Ano Informace o osobě a primárním zařazení do role a organizační jednotky.
attributeValues EosAttributeValues Ano Oprávnění aplikace pro konkrétní zařazení osoby do role.
orgRole EosOrgRole Ano Role, do které je osoba zařazená.
orgUnits EosOrgUnits Ano Seznam všech organizačních jednotek nad rolí osoby (neseřazené).