HighQ (Preview)

Tento konektor umožňuje zabezpečený a ověřený přístup k rozhraním API HighQ, což umožňuje bezproblémovou integraci funkcí pro spolupráci a správu obsahu do vlastních pracovních postupů a aplikací. Podporuje automatizaci dokumentů, synchronizaci dat a orchestraci pracovních postupů – umožňuje týmům právních a profesionálních služeb zjednodušit provoz, snížit ruční úsilí a zvýšit produktivitu.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD)

Kontakt
Název	Highq
URL	https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Email	highq-support@thomsonreuters.com

Metadata konektoru
Vydavatel	Thomson Automaticky Incorporated
Internetová stránka	https://legal.thomsonreuters.com/en/products/highq
Zásady ochrany osobních údajů	https://www.thomsonreuters.com/en/privacy-statement
Kategorie	Spolupráce; Obsah a soubory

HighQ

Přehled

HighQ poskytuje bezproblémový, zabezpečený a ověřený přístup k rozhraním API HighQ. Tento konektor umožňuje bezproblémovou interakci s různými službami HighQ, včetně modulů ISheet, rozhraní API prostředků dokumentů, rozhraní API pro správu ISheet a operací uživatelů. Je navržená tak, aby usnadnila integraci s platformou HighQ Collaborate, která nabízí funkce, jako je načítání a vytváření položek iSheet, správa souborů dokumentů a správa uživatelských účtů.

Verze konektoru: 1.0.0
Titul: HighQ
Popis: Tento konektor nabízí bezproblémový, zabezpečený a ověřený přístup k rozhraním API HighQ.
Kontakt:
- Jméno: Highq
- Web:Podpora HighQ
- E-mail:highq-support@thomsonreuters.com

Autentizace

Konektor využívá dynamické proměnné prostředí pro zabezpečené připojení:

Hostitel: @environmentVariables("highqt_host")
Základní cesta: /@environmentVariables("highqt_instancename")/api
ID klienta:@environmentVariables("highqt_clientid")
Tajný klíč klienta:@environmentVariables("highqt_clientsecret")

Podrobné postupy ověřování najdete na portálu technické podpory HighQ nebo se obraťte na podporu HighQ.

Operace konektoru

Modul ISheet

Načtení položek iSheetu
GET /{version}/isheet/{isheetid}/items
Načte seznam položek v zadaném listu iSheet.
Vytvoření položek iSheetu
POST /{version}/isheet/{isheetid}/items
Vloží nové položky do iSheetu s podporou více listů iSheet a sledování stavu prostřednictvím progresivních klíčů.

Rozhraní API pro prostředky dokumentů

Načtení informací o souboru
GET /{version}/files/{fileid}
Načte podrobné informace o konkrétním souboru na platformě HighQ Collaborate.
Nahrání souboru
POST /{version}/files/content
Nahraje soubor do zadané složky, která podporuje blokované nahrávání při Content-Range zadání hlavičky.
Načtení seznamu složek
GET /{version}/folders/{folderid}/items
Načte seznam složek v zadané složce s podporou řazení a stránkování.

Rozhraní API pro správu ISheetu

Načtení sloupců iSheet
GET /{version}/isheets/admin/{isheetid}/columns
Načte konfigurace sloupců pro daný list iSheet.

Operace uživatelů

Načtení uživatelů
GET /{version}/users
Načte seznam uživatelů s podporou filtrování, stránkování a podrobných rolí uživatelů.
Přidání nového uživatele
POST /{version}/users
Vytvoří nový uživatelský účet s rozšířenými atributy a ověřením.
Archivace uživatele
DELETE /{version}/users/{userid}
Archivuje existujícího uživatele ze systému.

Správa dokumentů a webů

Vytvoření složky
POST /{version}/folders
Vytvoří novou složku pod zadanou nadřazenou složkou.
Přesunout dokumenty
PUT /{version}/files/move
Přesune jeden nebo více souborů z jedné složky do druhé v rámci stejného webu.
Operace správy lokality:
- Přidat existující skupinu na web: POST /{version}/sites/{siteid}/groups/{groupid}
- Aktualizovat skupinu webů: PUT /{version}/sites/{siteid}/groups/{groupid}
- Přidat nový web: POST /{version}/sites

Začínáme

Konfigurace:
- Definujte proměnné highqt_host prostředí a highqt_instancename v prostředí Power Platform.
Authentication (Ověřování):
- Postupujte podle pokynů, které poskytuje HighQ, a nakonfigurujte zabezpečené ověřování pro požadavky rozhraní API.
Využití:
- Naimportujte highQ do instance Power Platform.
- Podle potřeby využijte dostupné operace. Pokyny najdete ve výše uvedených souhrnech operací.

Parametry a nastavení

Parametry cesty:
Zahrňte požadované parametry, například version, isheetid, fileidfolderid, a userid podle potřeby.
Parametry dotazu:
Volitelné parametry, jako je sheetviewid, sortcolumnidlimita offset jsou k dispozici pro upřesnění odpovědí rozhraní API.
Základní parametry:
U operací, které vyžadují text požadavku (např. vytváření položek iSheetu nebo uživatelů), se ujistěte, že požadavek dodržuje definovaná schémata (například isheetDBO, FolderDBOnebo IntegrationUserDBO).

Řešení potíží a omezení

Kódy chyb:
Standardní stavové kódy HTTP se používají napříč operacemi:
- 200 pro úspěšné operace
- 401 pro neoprávněný přístup
- 403 zakázáno nebo neúspěšné ověření
- 405 pro neplatné metody HTTP
- 500 pro vnitřní chyby serveru
  Podrobné popisy chyb najdete v dokumentaci k jednotlivým rozhraním API.
Omezení:
Některé koncové body můžou mít výchozí limity (např. výchozí limit hodnota 100 záznamů). Pro řazení a filtrování velkých datových sad se můžou vyžadovat další parametry.

Další zdroje

Podrobnější informace a rozšířenou dokumentaci najdete v tématu:

Technická podpora pro HighQ
Interní dokumentace k balíčku konektoru HighQ

Licencování a podpora

Podrobnosti o licencování a technická podpora:

Kontakt: Highq
Adresa URL podpory: Technická podpora HighQ
E-mail podpory: highq-support@thomsonreuters.com

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktualizace skupiny webů

Tato metoda rozhraní API aktualizuje název existující skupiny v lokalitě.
Toto rozhraní API bylo rozšířeno o aktualizaci názvu existující základní skupiny uživatelů na webu.

Aktualizace webu

Pomocí tohoto koncového bodu rozhraní API aktualizujte podrobnosti o existující lokalitě. Rozhraní API podporuje stejná pole použitá v rozhraní API pro vytvoření webu.

Tato metoda podporuje více čísel hmot pro přidání do webu pomocí rozhraní API verze 10 dále. Značka matternos označuje více čísel hmoty jen pro čtení nebo ne.

Verze 18 dále: Vyžaduje se kategorie (účel webu). Pokud je účel webu skrytý, zobrazí se zpráva; jinak se skryté účely webu nepřidávají na web.

Vlastník webu teď může být také přiřazen jiným uživatelům, ale musí být účastníky webu a mít roli vyšší než správce webu.

Verze 18 dále: Vlastník webu může na web přidat další uživatele.

Od rozhraní API verze 19 se zavádí nový modul s názvem customPages, který je úzce propojený s domovským modulem. Pokud je hodnota domovského modulu True, musí být customPages true a naopak.

Upozorňujeme, že všechny vlastnosti a prvky v odpovědi get webu nejsou aktualizovatelné nebo vložitelné. V následující tabulce zjistíte, které jsou jen pro čtení, aktualizovatelné nebo vložitelné.

Archivovat uživatele

Toto volání rozhraní API slouží k archivaci uživatele v systému.

Kódy chyb

Shrnutí	Referenční kód (před V4)	Referenční kód (V4)
Následující uživatelé v systému neexistují.	110	110
Vyžaduje se ID uživatele.	109	109
ID uživatele není ve správném formátu	113	113
Délka ID uživatele nesmí překročit 50 znaků.	N/A	304

Lístek JIRA: https://dev.highq.com/jira/browse/COL-67441

Načtení informací o souboru

Toto volání rozhraní API načte podrobné informace o zadaném souboru z platformy HighQ Collaborate.

Načtení seznamu položek iSheetu

Toto volání rozhraní API načte seznam položek obsažených v zadaném listu iSheet.

Načtení seznamu složek

Toto volání rozhraní API načte seznam složek obsažených v zadané složce. Parametr limit nastaví maximální počet položek, které se mají vrátit, a parametr posun určuje počáteční pozici pro načtení dat. Pokud tyto parametry vynecháte, použijí se výchozí hodnoty a složky se vrátí vzestupně podle data vytvoření.

Načtení seznamu uživatelů

Načte seznam uživatelů, toto rozhraní API načte seznam uživatelů ze systému. Klíčové funkce ## – Načtení podrobností o uživateli s více možnostmi filtrování – Podporuje stránkování s `limit` a `offset` – Nové parametry a pole dotazu představené v posledních verzích – Strukturovaná odpověď s rolemi a atributy uživatele ## Nové parametry dotazu (Version-Specific) – představené ve verzi 12: - `systemAdminSearch`: Pokud je `1`tato možnost nastavená, vrátí se jenom uživatelé s rolí správce systému. - Představeno ve V18: - `userid`: Přijímá hodnoty oddělené čárkami (CSV). Aktualizace textu odpovědi ## – Nová pole přidána: - , , , , `emaildomain`, `org`, `invitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalid`, , , `publicwebsiteprofileid` - , `systemuserresetpassworddateusertypeidavatar`, `practicegroup`# - # Změna formátu adresy (z V11) – Značka `langcode` byla přejmenována na `publicprofile` konzistenci. `dateOfBirthlocationaddress` – Příklad odpovědi: `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## Role uživatelů (zavedené v rozhraní API V11+) – Příklad odpovědi: `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Limity a posuny – Chování limitu: – Výchozí: `100` pokud není k dispozici žádná hodnota. - Slouží `-1` k vrácení všech záznamů. - Pokud je hodnota menší než `-1`, výchozí hodnota `100`je . - Chování posunu: – Výchozí: `0` pokud není k dispozici žádná hodnota. - Pokud posun překročí celkový počet záznamů, vrátí se zpět na `0`hodnotu . ## Nové role zavedeny – V12: `Basic User`, `Allow user to bypass XSS protection` - V14: `Allow user to manage Contract Express system groups` ## Kódy chyb | Souhrn | Referenční kód (před V4) | Referenční kód (V4) | |---------|----------------------|--------------| | Neplatný vstup pro stav uživatele (AKTIVNÍ, ARCHIVOVÁNO, NEAKTIVNÍ) | 147 | 147 | | ID organizace je neplatné | Není k dispozici | 260 | | Neplatná `neverinvited` hodnota (true/false) | Není k dispozici | 387 | | Neplatná `neverlogin` hodnota (true/false) | Není k dispozici | 388 | | Neplatná `groupids` hodnota | Není k dispozici | 214 | | Neplatná `notingroup` hodnota (true/false) | Není k dispozici | 389 | | Neplatné `ordertype` (podporované: jméno, organizace, stav atd.) | Není k dispozici | 289 | | Neplatné `orderby` (podporované: asc, desc) | Není k dispozici | 290 | | Neplatná `offset` hodnota | 138 | 138 | | Neplatná `limit` hodnota | 137 | 137 | ## Poznámky – Od verze 13 je toto rozhraní API otevřené pro všechny uživatele (dříve omezené na správce systému). – Od verze 18 dále pole označuje, `userregistered2FA` jestli je uživatel zaregistrovaný pro 2FA. --- Tento popis se řídí formátováním schématu Swagger 2.0 a měl by být umístěn do pole popisu ve schématu vlastního konektoru.

Načtení sloupců iSheet

Toto volání rozhraní API načte sloupce přidružené k zadanému iSheetu. Tato funkce je podporovaná v rozhraní API verze 3 a vyšší.

Odeslání souboru

Toto volání rozhraní API nahraje soubor do zadané složky na platformě HighQ Collaborate. Podporuje nahrávání bloků dat při zadání hlavičky Content-Range.

Přesunout dokumenty

Toto rozhraní API přesune více souborů z jedné složky do druhé v rámci stejného webu.

Přidat uživatele

Toto volání rozhraní API slouží k přidání nového uživatele do systému.
Poznámka:
1. Přidání podpory pro následující nová pole
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. Značka adresy byla přidána v rozhraní API verze 4.

Shrnutí	Referenční kód (před V4)	Referenční kód (V4)
Vyžaduje se e-mailová adresa.	101	101
Neplatná e-mailová adresa	104	104
Je požadováno jméno.	102	102
Maximální povolený počet znaků pro křestní jméno musí být v rozmezí od 1 do 100.	102	352
E-mailová adresa tajemníka nebo asistenta není platná.	104	353
Stav musí být aktivní nebo neaktivní.	116	116
Zadané oddělení nesmí být delší než 256 znaků.	N/A	354
Zadaný atribut ifpartner je neplatný.	N/A	355
Zadaný atribut systemuser je neplatný.	N/A	356
Zadaný atribut usertypeid je neplatný.	N/A	357
Zadaný atribut langcode je neplatný.	N/A	358
Zadaný atribut sourcetype je neplatný. Platné hodnoty jsou Systémové, Active Directory nebo Systémové výchozí .	N/A	359
Zadejte prosím platné telefonní číslo.	N/A	360
Zadejte platné telefonní číslo ve formátu {countrycode} ${areacode}${number}.	N/A	361
Zadejte platné číslo mobilního zařízení ve formátu {countrycode}${number}.	N/A	362
Zadejte platný kód země telefonního telefonu do kanceláře.	N/A	363
Kód země telefonního telefonu v kanceláři může mít maximálně 4 číslice.	N/A	364
Zadejte platný kód oblasti telefonní oblasti kanceláře.	N/A	365
Kód telefonní oblasti kanceláře může mít maximálně 5 číslic.	N/A	366
Telefonní číslo kanceláře by mělo mít maximálně 15 číslic.	N/A	368
Zadejte platný kód země mobilního telefonu.	N/A	369
Kód země mobilního telefonu může mít maximálně 4 číslice.	N/A	372
Zadejte platné číslo mobilního zařízení.	N/A	373
Číslo mobilního telefonu by mělo mít maximálně 20 číslic	N/A	374
Doména neexistuje.	105	105
E-mail už v systému existuje.	111	111
Zmiňte organizaci v případě samoregistrované domény.	187	187
Zmínit organizaci v případě výjimečné domény	115	115
ID organizace není ve správném formátu.	112	112
Organizace neexistuje	106	106
Doména existuje v jiné organizaci	114	114
Zadané ID adresy není platné.	N/A	308
Název odkazu na sociální sítě nebyl v systému nalezen.	N/A	375
Název odkazu na sociální sítě je povinný.	N/A	376
Hodnota sociálního propojení je povinná.	N/A	377
Maximální počet znaků pro hodnotu sociálního propojení musí být v rozmezí od 1 do 500.	N/A	378
Zadejte název vlastního odkazu.	N/A	379
Požadovaná hodnota vlastního propojení	N/A	380
Maximální počet znaků pro název vlastního propojení musí být v rozsahu 1 až 500.	N/A	381
Maximální počet znaků pro vlastní hodnotu propojení musí být v rozsahu 1 až 500.	N/A	382
Požadovaný název odkazu na zprávu	N/A	383
V systému nebyl nalezen název odkazu na zprávu.	N/A	384
Požadovaná hodnota odkazu na zprávu	N/A	385
Maximální počet znaků pro hodnotu propojení zpráv musí být v rozsahu 1 až 500.	N/A	386
Sociální odkaz je zakázaný.	N/A	408
Odkaz na zprávu je zakázaný.	N/A	409
Vlastní odkaz je zakázaný.	N/A	410

Lístek JIRA: https://dev.highq.com/jira/browse/COL-65685

Přidat web

Pomocí tohoto rozhraní API vytvořte nový web. Objekt lokality podporuje pouze atributy, které jsou viditelné v rozhraní pro vytvoření lokality.

Toto rozhraní API vyžaduje název webu (a povinná pole nakonfigurovaná na úrovni ASP, pokud existuje) k vytvoření nového webu.

Značka "module" představuje jiný modul, který se konfiguruje v lokalitě, protože se zobrazuje v atributech požadavku.
Vytvoření webu ze šablony předáním značky sitetemplateid
– Pro méně než verzi 7 se v požadavku nepředá žádná značka ("modul" není předána) se provede konfigurace modulu šablony. Pokud je značka modulu k dispozici s konfigurací, bude respektovat, že a nakonfiguruje ji tak, jak je uvedeno v požadavku (místo použití konfigurace modulu šablony).
– Pokud je v požadavku zadána nějaká značka modulu ("modul" je předána) nebo ne v požadavku, provede se konfigurace modulu šablony.

Tato metoda nepodporuje nahrávání obrázku webu v tomto volání, podpora ikon webu bude poskytována jako samostatné volání.
Volání metody očekává existující ID kategorie. ID kategorie by měla být získána volající aplikací dřívějším voláním rozhraní kategorií webu. Pokud v požadavku nejsou uvedeny žádné kategorie, ve výchozím nastavení se žádná kategorie (ne skutečná žádná kategorie) nepřidá.

Počáteční a koncové datum webu by mělo být ve formátu "dd MMM rrrr" a není to UTC. Klient rozhraní API vždy požádá o skutečné datum.

"landingpage" má výchozí hodnotu "files (kořenová složka)".
"landingpage" očekává tři různé formulace nebo identifikace pro modul File. Možné hodnoty:
– soubory (kořenová složka)
– soubory (nedávná aktivita)
- soubory (rozšířené vyhledávání)
Implementace metody nyní podporuje (od 5.1 dále) název vícejazyčného webu. Rozhraní API verze 6 nebo vyšší <název> webu bude reprezentovat v textu požadavku na základě pořadí předvoleb uživatele. Rozhraní API verze 5 nebo starší <název> webu bude představovat výchozí angličtinu v UK.
<Překlady> názvů webů budou představovat názvy webů v každém jazyce (což bude další značka v rozhraní API samotného objektu od 5.1 dále) rozhraní API verze 6 nebo vyšší, v textu požadavku odesílají obě značky<, tj. >název< webu a >název_webu, pak musíme ověřit hodnoty, <například název>_webu musí odpovídat příslušné <značce překladu> z hlediska jazykové předvolby uživatele. Rozhraní API 7 nebo vyšší, web vytvořený ze šablony bude sledovat moduly ze zdrojové šablony a bude ignorovat seznam modulů odeslaný v textu požadavku.

Implementace metody teď podporuje vytvoření webu ze šablony tím, že poskytuje značku sitetemplateid (starý přístup).

Upozorňujeme, že podpora vytváření webu ze šablony pomocí tohoto rozhraní API bude v budoucnu zastaralá. Pokud chcete vytvořit web ze šablony, použijte nový web pro vytvoření rozhraní API ze šablony (/sites/templates/{templateid}/site), což je dlouhé rozhraní API pro dotazování (s podporou dlouhotrvajících požadavků).

Tato metoda podporuje více čísel hmot pro přidání do webu pomocí rozhraní API verze 10 dále. Značka matternos označuje více čísel hmoty jen pro čtení nebo ne. Starší verze (menší než verze 10) číslo jedno hmoty "matterno" bude odrážet první číslo existující více hmot v lokalitě.

Verze 18 dále: Vyžaduje se kategorie (účel webu). Pokud je účel webu skrytý, zobrazí se zpráva; jinak se skryté účely webu nepřidávají na web.

Až do verze 17: vlastníkem webu je přihlášený uživatel; není možné přidat žádné další uživatele.

Verze 18 dále: Vlastník webu může na web přidat další uživatele.

Od rozhraní API verze 19 je zaveden nový modul s názvem customPages, který je úzce propojený s domovským modulem. Pokud je hodnota domovského modulu true, budou vlastní stránky true a naopak.

Přidání existující skupiny na web

Tato metoda rozhraní API přidá do lokality existující systémovou skupinu.
Toto rozhraní API bylo rozšířeno o přidání stávajících základních skupin uživatelů systému (systému nebo typu organizace) na webu.

Vytvoření položky iSheetu

Toto volání rozhraní API se používá k vložení položky iSheet. Je možné podporovat více listů iSheets.

Pokud chcete získat stav položky iSheetu na základě progresivního klíče, zavolejte rozhraní API POST /api/3/progressivekeystatus/{progressive_key}

například POST /api/{version}/progressivekeystatus/{progressive_key}

Název	Typ	Description
progressive_key	String	Klíč pro kontrolu stavu akce.

odpověď


              
              <progressivekeyresponse>

               \t<položek>

                \t\t<položka>

                 \t\t\t<itemid>1232</itemid>

                 \t\t\t<status>SUCCESS</status>

                 \t\t\t<statuscode 200>/statuscode<>

                 \t\t\t<záznam zprávy>byl úspěšně< přidán/zpráva>

                \t\t</item>

                \t\t<položka>

                 \t\t\t<itemid>1233</itemid>

                 \t\t\t<status>SUCCESS</status>

                 \t\t\t<statuscode 200>/statuscode<>

                 \t\t\t<záznam zprávy>byl úspěšně< přidán/zpráva>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Vytvořit složku

Toto rozhraní API vytvoří novou složku v zadané lokalitě. Umožňuje zadat podrobnosti o složce a zajistit, že se složka vytvoří v dané nadřazené složce.

Získání informací o složce

Metoda poskytuje podrobnosti o složce daného ID složky.

Aktualizace skupiny webů

ID operace:: updateSiteGroup

Tato metoda rozhraní API aktualizuje název existující skupiny v lokalitě.
Toto rozhraní API bylo rozšířeno o aktualizaci názvu existující základní skupiny uživatelů na webu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	verze
ID webu	siteid	True	string	ID webu.
Verze rozhraní API	groupid	True	string	`The ID of the site group.`
název	name		string
identifikační číslo	id		integer
copypermissionsfrom	copypermissionsfrom		string
zpráva	message		string
typeID	typeID		integer
typ	type		string
numberofusers	numberofusers		string
vytvořil	created		string
modified	modified		string
systemGroupID	systemGroupID		integer
popis	description		string
basicusergroup	basicusergroup		integer

Návraty

Body: sitegroup

Aktualizace webu

ID operace:: updateSite

Pomocí tohoto koncového bodu rozhraní API aktualizujte podrobnosti o existující lokalitě. Rozhraní API podporuje stejná pole použitá v rozhraní API pro vytvoření webu.

Tato metoda podporuje více čísel hmot pro přidání do webu pomocí rozhraní API verze 10 dále. Značka matternos označuje více čísel hmoty jen pro čtení nebo ne.

Verze 18 dále: Vyžaduje se kategorie (účel webu). Pokud je účel webu skrytý, zobrazí se zpráva; jinak se skryté účely webu nepřidávají na web.

Vlastník webu teď může být také přiřazen jiným uživatelům, ale musí být účastníky webu a mít roli vyšší než správce webu.

Verze 18 dále: Vlastník webu může na web přidat další uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Požadovaná verze rozhraní API	version	True	string	verze rozhraní API
Jedinečný identifikátor webu	siteid	True	string	ID webu
identifikační číslo	id		integer	Identifikátor webu.
název webu	sitename		string	Název webu.
role	role		string	Role lokality.
sitedescription	sitedescription		string	Popis webu.
enabledmodules	enabledmodules		string	Seznam modulů povolených pro web.
sitefolderID	sitefolderID		string	Identifikátor složky webu.
sitefolderpermission	sitefolderpermission		string	Úroveň oprávnění pro složku webu.
povolit	enable		string	Povolení stavu pro HomeDBO
povolit	enable		string	Povolení stavu pro ActivityDBO
mikroblog	microblog		string	Obsah mikroblogu přidružený k ActivityDBO.
docid	docid		string	ID dokumentu.
blogTitle	blogTitle		string	Název blogového příspěvku.
blogContent	blogContent		string	Obsah blogového příspěvku
showComment	showComment		integer	zobrazit komentář.
Seznam tagů	tagList		array of string	Seznam značek přidružených k blogu
stav	status		integer	stav příspěvku na blogu.
siteID	siteID		integer	Identifikátor přidružené lokality.
autor	author		string	Autor blogu.
categoryList	categoryList		array of string	Kategorie přiřazené k blogovém příspěvku
notificationTypeID	notificationTypeID		integer	Identifikátor typu oznámení.
zpráva	message		string	Obsah zprávy související s blogem
messageCode	messageCode		integer	Kód přidružený ke zprávě
Externí ID	externalID		string	Externí identifikátor propojený s blogem
Datum publikování	publishDate		string	Datum publikování blogu.
processtype	processtype		string	Typ procesu přidružený k blogu
povolit	enable		string	Povolte stav pro BlogDBO.
wikiid	wikiid		integer	Jedinečný identifikátor wikiwebu
currentversionid	currentversionid		integer	Identifikátor aktuální verze wikiwebu
parentwikiid	parentwikiid		integer	Identifikátor nadřazeného wikiwebu
wikititle	wikititle		string	Název wikiwebu
wikikontent	wikicontent		string	Obsah wikiwebu
showcomment	showcomment		integer	Označuje, jestli jsou povoleny komentáře.
createddate	createddate		string	Datum vytvoření wikiwebu
modifieddate	modifieddate		string	Datum poslední změny wikiwebu
seznam značek	taglist		string	Čárkami oddělený seznam značek přidružených k wikiwebu
wikipath	wikipath		string	Cesta pro přístup k wikiwebu
wikidraftid	wikidraftid		integer	Identifikátor konceptu verze wikiwebu
drafttype	drafttype		string	Typ konceptu přidruženého k wikiwebu
stav	status		integer	Aktuální stav wikiwebu
wikiversionid	wikiversionid		integer	Identifikátor verze wikiwebu.
index	index		string	Index nebo identifikátor úkolu.
parenttaskid	parenttaskid		integer	Identifikátor nadřazeného úkolu
taskid	taskid		integer	Jedinečný identifikátor úkolu.
title	title		string	Názevúkoluhoho
popis	description		string	Podrobný popis úkolu
duedate	duedate		string	Termín splnění dokončení úkolu
startdate	startdate		string	Počáteční datum, kdy byl úkol zahájen.
mattermaptaskid	mattermaptaskid		string	Identifikátor propojování s úkolem mapování hmoty.
typ	type		string	Zadejte nebo kategorii úkolu.
dependenton	dependenton		string	Úkoly, na které tento úkol závisí.
daysfromdependent	daysfromdependent		string	Počet dnů od závislého úkolu
ignoreweekend	ignoreweekend		integer	Označuje, jestli se při plánování ignorují víkendy.
duration	duration		integer	Doba trvání dokončení úkolu
prostředek	resource		string	Zdroje přiřazené k úkolu.
eventTitle	eventTitle		string	Název události.
eventContent	eventContent		string	Obsah události.
showComment	showComment		integer	Označuje, jestli jsou pro událost povoleny komentáře.
Seznam tagů	tagList		array of string	Seznam značek přidružených k události
stav	status		integer	Aktuální stav události
siteID	siteID		integer	Identifikátor webu.
kontakt	contact		string	Kontaktní informace pro událost.
categoryList	categoryList		array of string	Kategorie, pod kterými je událost uvedená.
notificationTypeID	notificationTypeID		integer	Typ oznámení související s událostí.
zpráva	message		string	Zpráva události.
messageCode	messageCode		integer	Kód zprávy události.
Externí ID	externalID		string	Externí identifikátor.
startDate	startDate		string	Počáteční datum události.
datum ukončení	endDate		string	Koncové datum události.
startTime	startTime		string	Čas zahájení události.
endTime	endTime		string	Čas ukončení události.
poloha	location		string	Umístění události.
autor	author		string	Autor události.
processtype	processtype		string	Doba zpracování události.
povolit	enable		string	Povolte událost.
identifikační číslo	id		integer	Jedinečný identifikátor listu iSheet.
title	title		string	Název iSheetu
popis	description		string	Popis isheetu
stav	status		string	Stav isheetu
accesstype	accesstype		string	Přístupový typ isheetu
typ	type		string	Typ listu.
viewlink	viewlink		string	Odkaz pro zobrazení iSheetu
možnosti povolení	allowsections		string	Určuje, jestli jsou oddíly povolené.
allowlookup	allowlookup		string	Určuje, jestli jsou vyhledávací pole povolená.
displayisheet	displayisheet		string	Zobrazit možnosti pro iSheet.
searchasdefaultview	searchasdefaultview		string	Označuje, jestli je hledání výchozím zobrazením.
enableversion	enableversion		string	Příznak s povolenou verzí
enablesheetalerter	enablesheetalerter		string	Příznak pro povolení upozornění listu
alertercondition	alertercondition		string	Podmínky pro aktivaci výstrah
overrideitemmodifieddate	overrideitemmodifieddate		string	Přepsat příznak datum změny
enablebulkinsertupdate	enablebulkinsertupdate		string	Povolte hromadné vložení nebo aktualizaci.
popisy polí	fielddescriptions		string	Popisy polí pro iSheet.
enablerowlocking	enablerowlocking		string	Povolte uzamykání na úrovni řádků.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Zkrácení víceřádkového textového příznaku
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Omezení znaků pro víceřádkové zkrácení
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Povolit opakované použití hodnot seznamu voleb
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Povolit opakované použití hodnot seznamu skóre
allowIsheetComments	allowIsheetComments		string	Povolit komentáře v iSheetu
shareRecordsLimit	shareRecordsLimit		integer	Omezení záznamů, které se můžou sdílet
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Povolený limit sdílených složek záznamů
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Povolte sdílení formulářů pro přidávání záznamů.
recordcount	recordcount		string	Aktuální počet záznamů.
listtypeid	sheettypeid		integer	ID typu listu iSheet
povolit	enable		string	Povolte funkci kontroly kvality.
ID uživatele	userid		integer	ID uživatele.
e-mail	email		string	e-mailová adresa.
httpavatar	httpavatar		string	Adresa URL protokolu HTTP avataru.
avatar	avatar		string	Obrázek avataru
userlink	userlink		string	Odkaz na profil uživatele
httplink	httplink		string	Odkaz HTTP na profil uživatele
telefon	phone		string	Telefonní číslo.
mobilní	mobile		string	Číslo mobilního zařízení
oddělení	department		string	Oddělení uživatele.
povolit	enable		string	Povolení integrace Contract Express
adminnote	adminnote		string	Poznámky pro správu související s webem
startdate	startdate		string	Počáteční datum operace webu.
enddate	enddate		string	Koncové datum operace webu.
createddate	createddate		string	Datum vytvoření webu.
archiveddate	archiveddate		string	Datum archivace webu.
clientno	clientno		string	Číslo klienta přidružené k lokalitě.
matterno	matterno		string	Číslo hmoty přidružené k webu.
landingpage	landingpage		string	Adresa URL cílové stránky pro web.
odkaz	link		string	Odkaz související s webem.
stav	status		string	Aktuální stav webu.
statusid	statusid		integer	Identifikátor stavu webu.
size	size		string	Velikost webu.
billingnotes	billingnotes		string	Poznámky týkající se fakturace webu
billingnextinvoicedate	billingnextinvoicedate		string	Datum další faktury pro web.
billinglastinvoicedate	billinglastinvoicedate		string	Datum poslední faktury pro web.
filepagecount	filepagecount		string	Celkový počet stránek souborů na webu.
maxpagecount	maxpagecount		string	Maximální povolený počet stránek pro soubory na webu.
sitehttplink	sitehttplink		string	Odkaz HTTP na web.
isSyncable	isSyncable		integer	Označuje, jestli je web synchronizovaný.
enforceusergroups	enforceusergroups		string	Skupiny uživatelů vynucované pro web.
csvSiteCategory	csvSiteCategory		string	Kategorie webu ve formátu CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Název webu ve výchozím jazyce.
viditelný	visible		integer	Označuje, jestli je web viditelný.
siteLogoName	siteLogoName		string	Název souboru s logem webu.
siteLogoFileSize	siteLogoFileSize		integer	Velikost souboru loga webu.
siteLogoHeight	siteLogoHeight		integer	Výška loga webu.
siteLogoWidth	siteLogoWidth		integer	Šířka loga webu.
siteStatus	siteStatus		integer	Stavový kód webu.
applySiteTerms	applySiteTerms		integer	Označuje, jestli se použijí termíny webu.
siteTerm	siteTerm		string	Podmínky použité na web.
termType	termType		integer	Typ podmínek použitých na web.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Určuje, jestli se při příštím přihlášení vyžadují podmínky webu.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Označuje, jestli jsou povolené výchozí termíny webu.
advancedQAPermission	advancedQAPermission		integer	Rozšířená úroveň oprávnění pro kontrolu kvality pro web.
isInternal	isInternal		integer	Označuje, jestli je web interní.
Psm	psm		integer	Identifikátor Product Service Manageru.
siteLabelDisplay	siteLabelDisplay		string	Popisek zobrazení webu.
allowSiteAdministration	allowSiteAdministration		integer	Označuje, jestli je povolená správa webu.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Povolení ochrany heslem na úrovni webu
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Povolení ochrany hesla na úrovni lokality
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Označuje, jestli ověřování pomocí hesla používá ověřovací aplikaci.
sitePassword	sitePassword		string	Heslo přidružené k webu.
ipRestrictionEnable	ipRestrictionEnable		integer	Povolení omezení PROTOKOLU IP pro přístup k lokalitě
availableIP	availableIP		string	Čárkami oddělený seznam IP adres povolených pro přístup k webu.
highqDrive	highqDrive		integer	Označuje, jestli je povolená integrace Jednotky HighQ.
applySiteHomePage	applySiteHomePage		integer	Pokud chcete použít vlastní domovskou stránku pro web.
siteHomePage	siteHomePage		string	Adresa URL vlastní domovské stránky webu
siteHomePageType	siteHomePageType		integer	Typ domovské stránky
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Pokud chcete nastavit další přihlášení na domovskou stránku webu.
applyDisplayContent	applyDisplayContent		integer	Chcete-li použít nastavení obsahu pro zobrazení.
displayContent	displayContent		string	Obsah, který se má zobrazit na webu
rssSecurity	rssSecurity		integer	Úroveň zabezpečení informačního kanálu RSS.
šifrované heslo	encryptedPassword		integer	Označuje, jestli je heslo webu zašifrované.
availableIPRangeCSV	availableIPRangeCSV		string	Čárkami oddělený seznam rozsahů IP adres povolených pro přístup k webu.
siteModuleID	siteModuleID		integer	Identifikátor modulu webu.
icalSecurity	icalSecurity		integer	Úroveň zabezpečení informačního kanálu iCal.
defaultDisplayContent	defaultDisplayContent		string	Výchozí obsah, který se má zobrazit na webu.
defaultEmailAlert	defaultEmailAlert		integer	Povolení výchozích e-mailových upozornění
excelReportFooter	excelReportFooter		integer	Obsahuje zápatí v excelových sestavách.
excelReportFooterText	excelReportFooterText		string	Text, který se má zobrazit v zápatí excelových sestav.
oznámeníMLJSON	announcementMLJSON		string	Oznámení ve formátu JSON pro web
typ šablony	templateType		integer	Typ šablony použité pro web
templateLicence	templateLicence		integer	Typ licence pro šablonu webu.
openChannelAppID	openChannelAppID		string	ID aplikace pro integraci s otevřeným kanálem
itemid	itemid		integer	Identifikátor položky přidružené k webu.
sitemetadatasheetid	sitemetadatasheetid		integer	ID listu metadat přidruženého k webu.
osobní web	mysite		boolean	Označuje, jestli se jedná o osobní web uživatele.
lastaccesseddate	lastaccesseddate		string	Datum a čas posledního přístupu k webu
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Výchozí karta metadat pro prohlížeč webu
documentMetadataViewId	documentMetadataViewId		integer	metadata dokumentu pro identifikátor zobrazení.
folderMetadataViewId	folderMetadataViewId		integer	metadata složky pro identifikátor zobrazení.
docSort	docSort		integer	Pořadí řazení dokumentů.
folderSort	folderSort		integer	Pořadí řazení složek.
defaultFolderRenderView	defaultFolderRenderView		integer	Určuje výchozí režim zobrazení pro složky.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Výchozí umístění pro přílohy úkolů
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Jedinečný identifikátor složky určené jako výchozí umístění pro přílohy úkolů.
oblíbený	favourite		string	stav oblíbených.
enabledocumentredaction	enabledocumentredaction		boolean	Určuje, jestli je pro web povolená redakce dokumentu.
mentiongroups	mentiongroups		integer	Uvedené skupiny.
enablefilerelationships	enablefilerelationships		boolean	Určuje, jestli jsou povolené relace souborů.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Úroveň oprávnění potřebná ke správě relací souborů.

Archivovat uživatele

ID operace:: deleteUser

Toto volání rozhraní API slouží k archivaci uživatele v systému.

Kódy chyb

Shrnutí	Referenční kód (před V4)	Referenční kód (V4)
Následující uživatelé v systému neexistují.	110	110
Vyžaduje se ID uživatele.	109	109
ID uživatele není ve správném formátu	113	113
Délka ID uživatele nesmí překročit 50 znaků.	N/A	304

Lístek JIRA: https://dev.highq.com/jira/browse/COL-67441

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	verze rozhraní API
ID uživatele	userid	True	string	ID uživatele

Načtení informací o souboru

ID operace:: getDocumentInfo

Toto volání rozhraní API načte podrobné informace o zadaném souboru z platformy HighQ Collaborate.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	Určuje verzi používaného rozhraní API.
ID souboru	fileid	True	string	Určuje jedinečné ID souboru.
Příznak Nejnovější informace o DMS	lastdmsinfo		boolean	Určuje, zda se mají načíst nejnovější informace ze systému správy dokumentů.
Typ složky	foldertype		string	Určuje typ složky, pokud je k dispozici.
Zahrnout informace o stavu souboru	statusinfo		boolean	Určuje, jestli se mají zahrnout další informace o stavu souboru, jako je sdílený stav, oblíbený stav, počet úkolů a stav lajku. Výchozí hodnota je false.
Zahrnout metadata e-mailu	emailmetadata		boolean	Určuje, jestli se mají zahrnout metadata e-mailu, jako jsou odesílatel, příjemci a časová razítka. Výchozí hodnota je false.

Návraty

Body: DocumentDBO

Načtení seznamu položek iSheetu

ID operace:: getISheetItems

Toto volání rozhraní API načte seznam položek obsažených v zadaném listu iSheet.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	Určuje verzi používaného rozhraní API.
ID listu iSheet	isheetid	True	integer	Určuje jedinečné ID listu iSheet.
ID zobrazení iSheet	sheetviewid		integer	Určuje ID zobrazení iSheet. Pokud toto vynecháte, vrátí se výchozí zobrazení.
Seřadit ID sloupce	sortcolumnid		integer	Určuje ID sloupce použitého pro řazení výsledků.
Pořadí řazení	sortorder		integer	Určuje pořadí řazení. Například 0 použijte pro vzestupné pořadí nebo jinou hodnotu pro sestupné pořadí.
Limit záznamů	limit		integer	Určuje maximální počet záznamů, které se mají vrátit; Výchozí hodnota je 100, pokud není zadána.
Posun záznamu	offset		integer	Určuje počáteční pozici pro načtení záznamu; výchozí hodnota je 0, pokud není zadána.
Zahrnout všechny sloupce	allColumnRequired		boolean	Příznak, který označuje, jestli se mají zahrnout všechna data sloupců bez ohledu na aktuální zobrazení.
Ignorovat omezení zobrazení	isIgnoreView		boolean	Příznak, který označuje, jestli se mají ignorovat omezení zobrazení při načítání dat položek.

Návraty

Name	Cesta	Typ	Description
isheet	isheet	array of object	Seznam položek iSheet.
Identifikátor položky	isheet.itemId	string	Jedinečné ID položky.
data	isheet.data	array of object	Podrobná data položky
sekvence	isheet.data.sequence	string	Pořadové číslo přidružené k datům.
columnDisplayName	isheet.data.columnDisplayName	string	Zobrazovaný název sloupce.
value	isheet.data.value	string	Hodnota obsažená ve sloupci.

Načtení seznamu složek

ID operace:: getFolderList

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	Určuje verzi používaného rozhraní API.
ID složky	folderid	True	string	Určuje jedinečné ID složky.
Limit položek	limit		string	Určuje maximální počet položek, které se mají vrátit.
Posun položek	offset		string	Určuje počáteční pozici pro vrácené položky.
Směr řazení	orderby		string	Určuje směr pořadí pro řazení položek. Pro vzestupné pořadí nebo desc pro sestupné pořadí použijte asc.
Kritérium řazení	ordertype		string	Určuje kritérium pro řazení položek, jako je jméno, autor nebo datum poslední změny.
Zahrnout informace o stavu složky	statusinfo		boolean	Určuje, zda se mají zahrnout další informace o stavu složky. Výchozí hodnota je false.
Zahrnout inteligentní složky	includesmartfolder		boolean	Určuje, jestli se mají do vráceného seznamu zahrnout inteligentní složky. Výchozí hodnota je false.

Návraty

Name	Cesta	Typ	Description
složka	folder	array of object
items	folder	object

Načtení seznamu uživatelů

ID operace:: getAllSystemUsers

Načte seznam uživatelů, toto rozhraní API načte seznam uživatelů ze systému. Klíčové funkce ## – Načtení podrobností o uživateli s více možnostmi filtrování – Podporuje stránkování s `limit` a `offset` – Nové parametry a pole dotazu představené v posledních verzích – Strukturovaná odpověď s rolemi a atributy uživatele ## Nové parametry dotazu (Version-Specific) – představené ve verzi 12: - `systemAdminSearch`: Pokud je `1`tato možnost nastavená, vrátí se jenom uživatelé s rolí správce systému. - Představeno ve V18: - `userid`: Přijímá hodnoty oddělené čárkami (CSV). Aktualizace textu odpovědi ## – Nová pole přidána: - , , , , `emaildomain`, `org`, `invitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalid`, , , `publicwebsiteprofileid` - , `systemuserresetpassworddateusertypeidavatar`, `practicegroup`# - # Změna formátu adresy (z V11) – Značka `langcode` byla přejmenována na `publicprofile` konzistenci. `dateOfBirthlocationaddress` – Příklad odpovědi: `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## Role uživatelů (zavedené v rozhraní API V11+) – Příklad odpovědi: `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Limity a posuny – Chování limitu: – Výchozí: `100` pokud není k dispozici žádná hodnota. - Slouží `-1` k vrácení všech záznamů. - Pokud je hodnota menší než `-1`, výchozí hodnota `100`je . - Chování posunu: – Výchozí: `0` pokud není k dispozici žádná hodnota. - Pokud posun překročí celkový počet záznamů, vrátí se zpět na `0`hodnotu . ## Nové role zavedeny – V12: `Basic User`, `Allow user to bypass XSS protection` - V14: `Allow user to manage Contract Express system groups` ## Kódy chyb | Souhrn | Referenční kód (před V4) | Referenční kód (V4) | |---------|----------------------|--------------| | Neplatný vstup pro stav uživatele (AKTIVNÍ, ARCHIVOVÁNO, NEAKTIVNÍ) | 147 | 147 | | ID organizace je neplatné | Není k dispozici | 260 | | Neplatná `neverinvited` hodnota (true/false) | Není k dispozici | 387 | | Neplatná `neverlogin` hodnota (true/false) | Není k dispozici | 388 | | Neplatná `groupids` hodnota | Není k dispozici | 214 | | Neplatná `notingroup` hodnota (true/false) | Není k dispozici | 389 | | Neplatné `ordertype` (podporované: jméno, organizace, stav atd.) | Není k dispozici | 289 | | Neplatné `orderby` (podporované: asc, desc) | Není k dispozici | 290 | | Neplatná `offset` hodnota | 138 | 138 | | Neplatná `limit` hodnota | 137 | 137 | ## Poznámky – Od verze 13 je toto rozhraní API otevřené pro všechny uživatele (dříve omezené na správce systému). – Od verze 18 dále pole označuje, `userregistered2FA` jestli je uživatel zaregistrovaný pro 2FA. --- Tento popis se řídí formátováním schématu Swagger 2.0 a měl by být umístěn do pole popisu ve schématu vlastního konektoru.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	Verze rozhraní API
Stav uživatele	status		string	Filtrovat uživatele podle stavu: Aktivní, Archivováno, Neaktivní nebo Uzamčeno.
Posun stránkování	offset		string	Počáteční pozice pro stránkování
Limit výsledků	limit		string	Počet položek, které se mají vrátit na požadavek
ID organizace	orgid		string	Filtrovat uživatele podle ID organizace
Nikdy nepozvaní uživatelé	neverinvited		string	Načtěte uživatele, kteří nikdy nebyli pozváni.
Nikdy nezaprotokolovaní uživatelé	neverlogin		string	Načtěte uživatele, kteří se nikdy nepřihlásili.
ID uživatele	userid		string	Filtrovat uživatele podle jejich jedinečných ID uživatelů
ID skupiny	groupid		string	Filtrovat uživatele podle ID skupin
Uživatelé, kteří nejsou ve skupinách	notingroup		string	Načtěte uživatele, kteří nejsou v žádné skupině.
Typ pořadí řazení	ordertype		string	Seřaďte uživatele podle zadaného pole, jako je název, organizace nebo stav.
Pořadí řazení	orderby		string	Výsledky seřadí vzestupně nebo sestupně.
Externí ID	externalid		string	Filtrovat uživatele podle externího ID
Křestní jméno	firstname		string	Filtrovat uživatele podle jména
Příjmení	lastname		string	Umožňuje filtrovat uživatele podle příjmení.
E-mailová adresa	email		string	Filtrovat uživatele podle e-mailové adresy
Vyhledávání uživatelů	search		string	Vyhledejte uživatele podle různých atributů, včetně jména, e-mailu a pracovní pozice.
Filtr abecedy	alphabets		string	Vyfiltrujte uživatele, jejichž příjmení začíná určitým písmenem.
Název pracovní pozice	jobtitle		string	Filtrovat uživatele podle pozice.
Umístění	locations		string	Filtrovat uživatele podle města
Oddělení	departments		string	Filtrovat uživatele podle oddělení
Název organizace	organisations		string	Filtrovat uživatele podle názvu organizace
Speciality	specialities		string	Filtrovat uživatele podle jejich specialit.
Vyhledávání správce systému	systemAdminSearch		string	Načtěte uživatele s rolí Správce systému.

Návraty

Body: users

Načtení sloupců iSheet

ID operace:: getIsheetColumns

Toto volání rozhraní API načte sloupce přidružené k zadanému iSheetu. Tato funkce je podporovaná v rozhraní API verze 3 a vyšší.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID listu iSheet	isheetid	True	integer	Určuje jedinečné ID iSheetu, pro které jsou sloupce požadovány.
Verze rozhraní API	version	True	string	Určuje verzi používaného rozhraní API.
ID zobrazení iSheet	sheetviewid		string	Určuje ID zobrazení iSheet. Pokud tento parametr vynecháte, vrátí se všechny sloupce.
Zahrnout odstraněné sloupce iSheetu	onlyForDeletedIsheet		boolean	Určuje, zda se mají zahrnout sloupce z odstraněného listu iSheet. Výchozí hodnota je false.

Návraty

Body: columns

Odeslání souboru

ID operace:: insertDocument

Toto volání rozhraní API nahraje soubor do zadané složky na platformě HighQ Collaborate. Podporuje nahrávání bloků dat při zadání hlavičky Content-Range.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	Určuje verzi používaného rozhraní API.
Soubor k nahrání	file	True	file	Určuje soubor, který se má nahrát.
ID nadřazené složky	parentfolderid	True	string	Určuje jedinečné ID nadřazené složky, do které se soubor nahraje.
Přepsání duplicitního příznaku	overrideduplicate		boolean	Určuje, jestli se mají přepsat duplicitní nahrávání souborů.
Název dokumentu	filename	True	string	Určuje název dokumentu.
Poznámka k verzi	versionnote		string	Obsahuje poznámku popisující verzi souboru.
Progresivní klíč operace	progressiveoperkey		string	Určuje klíč použitý pro progresivní operace během nahrávání souboru.
Název databáze DMS	dmsdatabasename		string	Určuje název databáze systému správy dokumentů.
Datum úpravy DMS	dmseditdate		string	Určuje datum úprav zaznamenané v systému správy dokumentů.
ID nadřazené složky DMS	dmsparentfolderid		string	Určuje jedinečné ID nadřazené složky v systému správy dokumentů.
ID dokumentu DMS	dmsdocid		string	Určuje jedinečné ID dokumentu v systému správy dokumentů.
Verze dokumentu DMS	dmsversion		string	Určuje verzi dokumentu zaznamenaného v systému správy dokumentů.
Podrobnosti o oznámení	notification		string	Obsahuje podrobnosti o všech oznámeních, která se mají odeslat při nahrání souboru.
ID dávky	batchid		string	Určuje jedinečné ID dávkové operace.
ID kořenové složky	rootfolderid		string	Určuje jedinečné ID kořenové složky.

Přesunout dokumenty

ID operace:: moveDocuments

Toto rozhraní API přesune více souborů z jedné složky do druhé v rámci stejného webu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	Určuje verzi rozhraní API.
ID cílové složky	targetfolder	True	string	Jedinečný identifikátor cílové složky, kam se soubory přesunou.
fileidCSV	fileidCSV		string	Seznam ID souborů oddělených čárkami, které se mají přesunout.

Přidat uživatele

ID operace:: createUser

Shrnutí	Referenční kód (před V4)	Referenční kód (V4)
Vyžaduje se e-mailová adresa.	101	101
Neplatná e-mailová adresa	104	104
Je požadováno jméno.	102	102
Maximální povolený počet znaků pro křestní jméno musí být v rozmezí od 1 do 100.	102	352
E-mailová adresa tajemníka nebo asistenta není platná.	104	353
Stav musí být aktivní nebo neaktivní.	116	116
Zadané oddělení nesmí být delší než 256 znaků.	N/A	354
Zadaný atribut ifpartner je neplatný.	N/A	355
Zadaný atribut systemuser je neplatný.	N/A	356
Zadaný atribut usertypeid je neplatný.	N/A	357
Zadaný atribut langcode je neplatný.	N/A	358
Zadaný atribut sourcetype je neplatný. Platné hodnoty jsou Systémové, Active Directory nebo Systémové výchozí .	N/A	359
Zadejte prosím platné telefonní číslo.	N/A	360
Zadejte platné telefonní číslo ve formátu {countrycode} ${areacode}${number}.	N/A	361
Zadejte platné číslo mobilního zařízení ve formátu {countrycode}${number}.	N/A	362
Zadejte platný kód země telefonního telefonu do kanceláře.	N/A	363
Kód země telefonního telefonu v kanceláři může mít maximálně 4 číslice.	N/A	364
Zadejte platný kód oblasti telefonní oblasti kanceláře.	N/A	365
Kód telefonní oblasti kanceláře může mít maximálně 5 číslic.	N/A	366
Telefonní číslo kanceláře by mělo mít maximálně 15 číslic.	N/A	368
Zadejte platný kód země mobilního telefonu.	N/A	369
Kód země mobilního telefonu může mít maximálně 4 číslice.	N/A	372
Zadejte platné číslo mobilního zařízení.	N/A	373
Číslo mobilního telefonu by mělo mít maximálně 20 číslic	N/A	374
Doména neexistuje.	105	105
E-mail už v systému existuje.	111	111
Zmiňte organizaci v případě samoregistrované domény.	187	187
Zmínit organizaci v případě výjimečné domény	115	115
ID organizace není ve správném formátu.	112	112
Organizace neexistuje	106	106
Doména existuje v jiné organizaci	114	114
Zadané ID adresy není platné.	N/A	308
Název odkazu na sociální sítě nebyl v systému nalezen.	N/A	375
Název odkazu na sociální sítě je povinný.	N/A	376
Hodnota sociálního propojení je povinná.	N/A	377
Maximální počet znaků pro hodnotu sociálního propojení musí být v rozmezí od 1 do 500.	N/A	378
Zadejte název vlastního odkazu.	N/A	379
Požadovaná hodnota vlastního propojení	N/A	380
Maximální počet znaků pro název vlastního propojení musí být v rozsahu 1 až 500.	N/A	381
Maximální počet znaků pro vlastní hodnotu propojení musí být v rozsahu 1 až 500.	N/A	382
Požadovaný název odkazu na zprávu	N/A	383
V systému nebyl nalezen název odkazu na zprávu.	N/A	384
Požadovaná hodnota odkazu na zprávu	N/A	385
Maximální počet znaků pro hodnotu propojení zpráv musí být v rozsahu 1 až 500.	N/A	386
Sociální odkaz je zakázaný.	N/A	408
Odkaz na zprávu je zakázaný.	N/A	409
Vlastní odkaz je zakázaný.	N/A	410

Lístek JIRA: https://dev.highq.com/jira/browse/COL-65685

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	verze rozhraní API
index	index		integer	Jedinečný index pro uživatele
ID uživatele	userid		integer	Jedinečný identifikátor uživatele.
křestní jméno	firstname		string	Jméno uživatele.
příjmení	lastname		string	Příjmení uživatele.
praktická skupina	practicegroup		string	Procvičte si seskupení, do které uživatel patří.
langcode	langcode		string	Kód jazyka uživatele
localeID	localeID		string	ID národního prostředí uživatele.
publicprofile	publicprofile		string	Veřejný profil uživatele.
pwpid	pwpid		string	ID PWP uživatele.
usertypeid	usertypeid		string	ID typu uživatele.
systemuser	systemuser		string	Příznak uživatele systému.
e-mail	email		string	Email adresu uživatele.
telefon	phone		string	Telefonní číslo uživatele
mobilní	mobile		string	Číslo mobilního zařízení uživatele
oddělení	department		string	Oddělení uživatele.
organizace	org		string	Organizace, do které uživatel patří.
addressline1	addressline1		string	První řádek adresy.
addressline2	addressline2		string	Druhý řádek adresy.
addressline3	addressline3		string	Třetí řádek adresy.
město	city		string	Město adresy.
stav	state		string	Stav adresy.
země	country		string	Země adresy.
PSČ	postcode		string	Poštovní směrovací číslo adresy.
addressid	addressid		string	Jedinečný identifikátor adresy.
addressline1	addressline1		string	První řádek adresy.
addressline2	addressline2		string	Druhý řádek adresy.
addressline3	addressline3		string	Třetí řádek adresy.
město	city		string	Město adresy.
stav	state		string	Stav adresy.
země	country		string	Země adresy.
PSČ	postCode		string	Poštovní směrovací číslo adresy.
poleas	knownas		string	Alternativní jméno nebo přezdívka adresy
zkušenost	experience		array of string
identifikační číslo	id		string	ID odkazu
název	name		string	Název odkazu.
value	value		string	Hodnota propojení.
identifikační číslo	id		string	ID odkazu
název	name		string	Název odkazu.
value	value		string	Hodnota propojení.
identifikační číslo	id		string	ID odkazu
název	name		string	Název odkazu.
value	value		string	Hodnota propojení.
img	img		string
reportsto	reportsto		string
název metadat	metadataname		array of string
metadatavalue	metadatavalue		array of string
seskupit	group		array of string
externalid	externalid		string	Externí ID uživatele
pracovní pozice	jobtitle		string	Pracovní pozice uživatele.
sekretářka	secretaryname		string	Jméno tajemníka uživatele.
sekretářka	secretarymail		string	E-mail sekretáře uživatele.
speciality	specialities		string	Speciality uživatele.
title	title		string	Název uživatele.
goesby	goesby		string	preferované jméno uživatele.
přípona	suffix		string	Přípona uživatelského jména.
atomlink	atomlink		string	Odkaz Atom přidružený k uživateli
bio	bio		string	Životopis uživatele.
dateOfBirth	dateOfBirth		string	Datum narození uživatele.
odkaz	link		string	Odkaz přidružený k uživateli
stav	status		string	Stav uživatele
stavový kód	statuscode		string	Stavový kód uživatele
zpráva	message		string	Zpráva přidružená k uživateli
sourcetype	sourcetype		string	Typ zdroje uživatele
orgid	orgid		string	ID organizace.
ifpartner	ifpartner		string	Příznak partnera.
emaildomain	emaildomain		string	E-mailová doména uživatele
pozvánky	invitationsent		string	Příznak odeslané pozvánky
vytvořil(a)	createdby		string	Uživatel, který záznam vytvořil
createddate	createddate		string	Datum vytvoření záznamu
modifikoval	modifiedby		string	Uživatel, který záznam upravil
modifieddate	modifieddate		string	Datum změny záznamu
lastlogindate	lastlogindate		string	Datum posledního přihlášení
invalidlogins	invalidlogins		string	Počet neplatných pokusů o přihlášení
publicwebsiteprofileid	publicwebsiteprofileid		string	ID profilu veřejného webu.
resetpassworddate	resetpassworddate		string	Datum resetování hesla
avatar	avatar		string	Adresa URL obrázku avataru
následující počet	followingcount		integer	Početsledovaných
followercount	followercount		integer	Počet sledujících.
následující	following		boolean	Následující příznak
role	role		string	Role uživatele
isbasicuser	isbasicuser		string	Základní příznak uživatele.
encryptedUserId	encryptedUserId		string	Šifrované ID uživatele
selfregistered	selfregistered		integer	Příznak zaregistrovaný vlastním držitelem.
registeredWith2FA	registeredWith2FA		string	Příznak registrace dvojúrovňového ověřování
isInternal	isInternal		integer	Příznak interního uživatele
orgName	orgName		string	Název organizace.

Návraty

Body: IntegrationUserDBO

Přidat web

ID operace:: createSite

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Požadovaná verze rozhraní API	version	True	string	verze rozhraní API
identifikační číslo	id		integer	Identifikátor webu.
název webu	sitename		string	Název webu.
role	role		string	Role lokality.
sitedescription	sitedescription		string	Popis webu.
enabledmodules	enabledmodules		string	Seznam modulů povolených pro web.
sitefolderID	sitefolderID		string	Identifikátor složky webu.
sitefolderpermission	sitefolderpermission		string	Úroveň oprávnění pro složku webu.
povolit	enable		string	Povolení stavu pro HomeDBO
povolit	enable		string	Povolení stavu pro ActivityDBO
mikroblog	microblog		string	Obsah mikroblogu přidružený k ActivityDBO.
docid	docid		string	ID dokumentu.
blogTitle	blogTitle		string	Název blogového příspěvku.
blogContent	blogContent		string	Obsah blogového příspěvku
showComment	showComment		integer	zobrazit komentář.
Seznam tagů	tagList		array of string	Seznam značek přidružených k blogu
stav	status		integer	stav příspěvku na blogu.
siteID	siteID		integer	Identifikátor přidružené lokality.
autor	author		string	Autor blogu.
categoryList	categoryList		array of string	Kategorie přiřazené k blogovém příspěvku
notificationTypeID	notificationTypeID		integer	Identifikátor typu oznámení.
zpráva	message		string	Obsah zprávy související s blogem
messageCode	messageCode		integer	Kód přidružený ke zprávě
Externí ID	externalID		string	Externí identifikátor propojený s blogem
Datum publikování	publishDate		string	Datum publikování blogu.
processtype	processtype		string	Typ procesu přidružený k blogu
povolit	enable		string	Povolte stav pro BlogDBO.
wikiid	wikiid		integer	Jedinečný identifikátor wikiwebu
currentversionid	currentversionid		integer	Identifikátor aktuální verze wikiwebu
parentwikiid	parentwikiid		integer	Identifikátor nadřazeného wikiwebu
wikititle	wikititle		string	Název wikiwebu
wikikontent	wikicontent		string	Obsah wikiwebu
showcomment	showcomment		integer	Označuje, jestli jsou povoleny komentáře.
createddate	createddate		string	Datum vytvoření wikiwebu
modifieddate	modifieddate		string	Datum poslední změny wikiwebu
seznam značek	taglist		string	Čárkami oddělený seznam značek přidružených k wikiwebu
wikipath	wikipath		string	Cesta pro přístup k wikiwebu
wikidraftid	wikidraftid		integer	Identifikátor konceptu verze wikiwebu
drafttype	drafttype		string	Typ konceptu přidruženého k wikiwebu
stav	status		integer	Aktuální stav wikiwebu
wikiversionid	wikiversionid		integer	Identifikátor verze wikiwebu.
index	index		string	Index nebo identifikátor úkolu.
parenttaskid	parenttaskid		integer	Identifikátor nadřazeného úkolu
taskid	taskid		integer	Jedinečný identifikátor úkolu.
title	title		string	Názevúkoluhoho
popis	description		string	Podrobný popis úkolu
duedate	duedate		string	Termín splnění dokončení úkolu
startdate	startdate		string	Počáteční datum, kdy byl úkol zahájen.
mattermaptaskid	mattermaptaskid		string	Identifikátor propojování s úkolem mapování hmoty.
typ	type		string	Zadejte nebo kategorii úkolu.
dependenton	dependenton		string	Úkoly, na které tento úkol závisí.
daysfromdependent	daysfromdependent		string	Počet dnů od závislého úkolu
ignoreweekend	ignoreweekend		integer	Označuje, jestli se při plánování ignorují víkendy.
duration	duration		integer	Doba trvání dokončení úkolu
prostředek	resource		string	Zdroje přiřazené k úkolu.
eventTitle	eventTitle		string	Název události.
eventContent	eventContent		string	Obsah události.
showComment	showComment		integer	Označuje, jestli jsou pro událost povoleny komentáře.
Seznam tagů	tagList		array of string	Seznam značek přidružených k události
stav	status		integer	Aktuální stav události
siteID	siteID		integer	Identifikátor webu.
kontakt	contact		string	Kontaktní informace pro událost.
categoryList	categoryList		array of string	Kategorie, pod kterými je událost uvedená.
notificationTypeID	notificationTypeID		integer	Typ oznámení související s událostí.
zpráva	message		string	Zpráva události.
messageCode	messageCode		integer	Kód zprávy události.
Externí ID	externalID		string	Externí identifikátor.
startDate	startDate		string	Počáteční datum události.
datum ukončení	endDate		string	Koncové datum události.
startTime	startTime		string	Čas zahájení události.
endTime	endTime		string	Čas ukončení události.
poloha	location		string	Umístění události.
autor	author		string	Autor události.
processtype	processtype		string	Doba zpracování události.
povolit	enable		string	Povolte událost.
identifikační číslo	id		integer	Jedinečný identifikátor listu iSheet.
title	title		string	Název iSheetu
popis	description		string	Popis isheetu
stav	status		string	Stav isheetu
accesstype	accesstype		string	Přístupový typ isheetu
typ	type		string	Typ listu.
viewlink	viewlink		string	Odkaz pro zobrazení iSheetu
možnosti povolení	allowsections		string	Určuje, jestli jsou oddíly povolené.
allowlookup	allowlookup		string	Určuje, jestli jsou vyhledávací pole povolená.
displayisheet	displayisheet		string	Zobrazit možnosti pro iSheet.
searchasdefaultview	searchasdefaultview		string	Označuje, jestli je hledání výchozím zobrazením.
enableversion	enableversion		string	Příznak s povolenou verzí
enablesheetalerter	enablesheetalerter		string	Příznak pro povolení upozornění listu
alertercondition	alertercondition		string	Podmínky pro aktivaci výstrah
overrideitemmodifieddate	overrideitemmodifieddate		string	Přepsat příznak datum změny
enablebulkinsertupdate	enablebulkinsertupdate		string	Povolte hromadné vložení nebo aktualizaci.
popisy polí	fielddescriptions		string	Popisy polí pro iSheet.
enablerowlocking	enablerowlocking		string	Povolte uzamykání na úrovni řádků.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Zkrácení víceřádkového textového příznaku
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Omezení znaků pro víceřádkové zkrácení
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Povolit opakované použití hodnot seznamu voleb
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Povolit opakované použití hodnot seznamu skóre
allowIsheetComments	allowIsheetComments		string	Povolit komentáře v iSheetu
shareRecordsLimit	shareRecordsLimit		integer	Omezení záznamů, které se můžou sdílet
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Povolený limit sdílených složek záznamů
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Povolte sdílení formulářů pro přidávání záznamů.
recordcount	recordcount		string	Aktuální počet záznamů.
listtypeid	sheettypeid		integer	ID typu listu iSheet
povolit	enable		string	Povolte funkci kontroly kvality.
ID uživatele	userid		integer	ID uživatele.
e-mail	email		string	e-mailová adresa.
httpavatar	httpavatar		string	Adresa URL protokolu HTTP avataru.
avatar	avatar		string	Obrázek avataru
userlink	userlink		string	Odkaz na profil uživatele
httplink	httplink		string	Odkaz HTTP na profil uživatele
telefon	phone		string	Telefonní číslo.
mobilní	mobile		string	Číslo mobilního zařízení
oddělení	department		string	Oddělení uživatele.
povolit	enable		string	Povolení integrace Contract Express
adminnote	adminnote		string	Poznámky pro správu související s webem
startdate	startdate		string	Počáteční datum operace webu.
enddate	enddate		string	Koncové datum operace webu.
createddate	createddate		string	Datum vytvoření webu.
archiveddate	archiveddate		string	Datum archivace webu.
clientno	clientno		string	Číslo klienta přidružené k lokalitě.
matterno	matterno		string	Číslo hmoty přidružené k webu.
landingpage	landingpage		string	Adresa URL cílové stránky pro web.
odkaz	link		string	Odkaz související s webem.
stav	status		string	Aktuální stav webu.
statusid	statusid		integer	Identifikátor stavu webu.
size	size		string	Velikost webu.
billingnotes	billingnotes		string	Poznámky týkající se fakturace webu
billingnextinvoicedate	billingnextinvoicedate		string	Datum další faktury pro web.
billinglastinvoicedate	billinglastinvoicedate		string	Datum poslední faktury pro web.
filepagecount	filepagecount		string	Celkový počet stránek souborů na webu.
maxpagecount	maxpagecount		string	Maximální povolený počet stránek pro soubory na webu.
sitehttplink	sitehttplink		string	Odkaz HTTP na web.
isSyncable	isSyncable		integer	Označuje, jestli je web synchronizovaný.
enforceusergroups	enforceusergroups		string	Skupiny uživatelů vynucované pro web.
csvSiteCategory	csvSiteCategory		string	Kategorie webu ve formátu CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Název webu ve výchozím jazyce.
viditelný	visible		integer	Označuje, jestli je web viditelný.
siteLogoName	siteLogoName		string	Název souboru s logem webu.
siteLogoFileSize	siteLogoFileSize		integer	Velikost souboru loga webu.
siteLogoHeight	siteLogoHeight		integer	Výška loga webu.
siteLogoWidth	siteLogoWidth		integer	Šířka loga webu.
siteStatus	siteStatus		integer	Stavový kód webu.
applySiteTerms	applySiteTerms		integer	Označuje, jestli se použijí termíny webu.
siteTerm	siteTerm		string	Podmínky použité na web.
termType	termType		integer	Typ podmínek použitých na web.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Určuje, jestli se při příštím přihlášení vyžadují podmínky webu.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Označuje, jestli jsou povolené výchozí termíny webu.
advancedQAPermission	advancedQAPermission		integer	Rozšířená úroveň oprávnění pro kontrolu kvality pro web.
isInternal	isInternal		integer	Označuje, jestli je web interní.
Psm	psm		integer	Identifikátor Product Service Manageru.
siteLabelDisplay	siteLabelDisplay		string	Popisek zobrazení webu.
allowSiteAdministration	allowSiteAdministration		integer	Označuje, jestli je povolená správa webu.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Povolení ochrany heslem na úrovni webu
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Povolení ochrany hesla na úrovni lokality
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Označuje, jestli ověřování pomocí hesla používá ověřovací aplikaci.
sitePassword	sitePassword		string	Heslo přidružené k webu.
ipRestrictionEnable	ipRestrictionEnable		integer	Povolení omezení PROTOKOLU IP pro přístup k lokalitě
availableIP	availableIP		string	Čárkami oddělený seznam IP adres povolených pro přístup k webu.
highqDrive	highqDrive		integer	Označuje, jestli je povolená integrace Jednotky HighQ.
applySiteHomePage	applySiteHomePage		integer	Pokud chcete použít vlastní domovskou stránku pro web.
siteHomePage	siteHomePage		string	Adresa URL vlastní domovské stránky webu
siteHomePageType	siteHomePageType		integer	Typ domovské stránky
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Pokud chcete nastavit další přihlášení na domovskou stránku webu.
applyDisplayContent	applyDisplayContent		integer	Chcete-li použít nastavení obsahu pro zobrazení.
displayContent	displayContent		string	Obsah, který se má zobrazit na webu
rssSecurity	rssSecurity		integer	Úroveň zabezpečení informačního kanálu RSS.
šifrované heslo	encryptedPassword		integer	Označuje, jestli je heslo webu zašifrované.
availableIPRangeCSV	availableIPRangeCSV		string	Čárkami oddělený seznam rozsahů IP adres povolených pro přístup k webu.
siteModuleID	siteModuleID		integer	Identifikátor modulu webu.
icalSecurity	icalSecurity		integer	Úroveň zabezpečení informačního kanálu iCal.
defaultDisplayContent	defaultDisplayContent		string	Výchozí obsah, který se má zobrazit na webu.
defaultEmailAlert	defaultEmailAlert		integer	Povolení výchozích e-mailových upozornění
excelReportFooter	excelReportFooter		integer	Obsahuje zápatí v excelových sestavách.
excelReportFooterText	excelReportFooterText		string	Text, který se má zobrazit v zápatí excelových sestav.
oznámeníMLJSON	announcementMLJSON		string	Oznámení ve formátu JSON pro web
typ šablony	templateType		integer	Typ šablony použité pro web
templateLicence	templateLicence		integer	Typ licence pro šablonu webu.
openChannelAppID	openChannelAppID		string	ID aplikace pro integraci s otevřeným kanálem
itemid	itemid		integer	Identifikátor položky přidružené k webu.
sitemetadatasheetid	sitemetadatasheetid		integer	ID listu metadat přidruženého k webu.
osobní web	mysite		boolean	Označuje, jestli se jedná o osobní web uživatele.
lastaccesseddate	lastaccesseddate		string	Datum a čas posledního přístupu k webu
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Výchozí karta metadat pro prohlížeč webu
documentMetadataViewId	documentMetadataViewId		integer	metadata dokumentu pro identifikátor zobrazení.
folderMetadataViewId	folderMetadataViewId		integer	metadata složky pro identifikátor zobrazení.
docSort	docSort		integer	Pořadí řazení dokumentů.
folderSort	folderSort		integer	Pořadí řazení složek.
defaultFolderRenderView	defaultFolderRenderView		integer	Určuje výchozí režim zobrazení pro složky.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Výchozí umístění pro přílohy úkolů
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Jedinečný identifikátor složky určené jako výchozí umístění pro přílohy úkolů.
oblíbený	favourite		string	stav oblíbených.
enabledocumentredaction	enabledocumentredaction		boolean	Určuje, jestli je pro web povolená redakce dokumentu.
mentiongroups	mentiongroups		integer	Uvedené skupiny.
enablefilerelationships	enablefilerelationships		boolean	Určuje, jestli jsou povolené relace souborů.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Úroveň oprávnění potřebná ke správě relací souborů.

Návraty

Body: site

Přidání existující skupiny na web

ID operace:: addExistingGroupToSite

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	verze
ID webu	siteid	True	string	ID webu.
ID systémové skupiny	groupid	True	string	ID systémové skupiny, která se má přidat do lokality.

Návraty

Body: sitegroup

Vytvoření položky iSheetu

ID operace:: insertISheetItems

Toto volání rozhraní API se používá k vložení položky iSheet. Je možné podporovat více listů iSheets.

Pokud chcete získat stav položky iSheetu na základě progresivního klíče, zavolejte rozhraní API POST /api/3/progressivekeystatus/{progressive_key}

například POST /api/{version}/progressivekeystatus/{progressive_key}

Název	Typ	Description
progressive_key	String	Klíč pro kontrolu stavu akce.

odpověď


              
              <progressivekeyresponse>

               \t<položek>

                \t\t<položka>

                 \t\t\t<itemid>1232</itemid>

                 \t\t\t<status>SUCCESS</status>

                 \t\t\t<statuscode 200>/statuscode<>

                 \t\t\t<záznam zprávy>byl úspěšně< přidán/zpráva>

                \t\t</item>

                \t\t<položka>

                 \t\t\t<itemid>1233</itemid>

                 \t\t\t<status>SUCCESS</status>

                 \t\t\t<statuscode 200>/statuscode<>

                 \t\t\t<záznam zprávy>byl úspěšně< přidán/zpráva>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	Verze rozhraní API
Identifikátor iSheetu	isheetid	True	integer	ID listu iSheet
Identifikátor zobrazení listu	sheetviewid		integer	ID zobrazení iSheet (volitelné)
identifikační číslo	id		integer	Identifikátor listu Isheet.
title	title		string	Název listu
popis	description		string	Popis listu
stav	status		string	Stav listu
accesstype	accesstype		string	Přístupový typ listu
typ	type		string	Typ listu
viewlink	viewlink		string	Odkaz na adresu URL pro zobrazení listu
možnosti povolení	allowsections		string	Označuje, jestli jsou oddíly povolené.
allowlookup	allowlookup		string	Označuje, jestli je povolené vyhledávání.
displayisheet	displayisheet		string	Zobrazit isheet.
searchasdefaultview	searchasdefaultview		string	Nastaví hledání jako výchozí zobrazení.
enableversion	enableversion		string	Povolit verzi.
enablesheetalerter	enablesheetalerter		string	Aktivuje výstrahu listu.
alertercondition	alertercondition		string	Podmínka pro aktivaci výstrah
overrideitemmodifieddate	overrideitemmodifieddate		string	Přes jízdu je datum změny položky.
enablebulkinsertupdate	enablebulkinsertupdate		string	Povolit hromadnou aktualizaci vložení
popisy polí	fielddescriptions		string	popis polí.
enablerowlocking	enablerowlocking		string	Povolí uzamčení řádků.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Povolí zkrácení limitu znaků pro víceřádkový text.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	nastaví omezení znaků pro zkrácení.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Umožňuje opakované použití hodnot seznamu voleb.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Umožňuje opakované použití hodnot seznamu skóre.
allowIsheetComments	allowIsheetComments		string	Povoluje komentáře na listu.
shareRecordsLimit	shareRecordsLimit		integer	Omezení sdílených záznamů
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Povolte limit sdílení záznamů.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Umožňuje sdílení formuláře pro přidání záznamu.
allowViewBaseRendering	allowViewBaseRendering		string	Umožňuje základní vykreslování zobrazení.
sloupec	column		object
recordcount	recordcount		string	Celkový počet záznamů
viewId	viewId		integer	Jedinečný identifikátor zobrazení.
siteId	siteId		integer	Identifikátor přidružené lokality.
název webu	siteName		string	Název webu.
sheetName	sheetName		string	Název listu
viewName	viewName		string	Název zobrazení
sheetId	sheetId		integer	Identifikátor listu.
sekvence	sequence		string	Pořadové číslo sloupce záhlaví
columnValue	columnValue		string	Hodnota sloupce záhlaví
columnTypeId	columnTypeId		string	Identifikátor pro typ sloupce.
columnId	columnId		string	Jedinečný identifikátor sloupce.
columnTypeAlias	columnTypeAlias		string	Název aliasu pro typ sloupce
itemsequence	itemsequence		string	Pořadové číslo položky
itemid	itemid		string	Jedinečný identifikátor položky.
externalid	externalid		string	Externí identifikátor přidružený k položce
columnid	columnid		integer	Jedinečný identifikátor sloupce
název	name		string	Název sloupce
typ	type		integer	Datový typ sloupce
systemgeneratedtype	systemgeneratedtype		string	Informace o typu generované systémem.
section	section		integer	Číslo oddílu, kde se nachází sloupec.
popis	description		string	Podrobný popis sloupce
addtodefaultview	addtodefaultview		string	Označuje, jestli je sloupec přidán do výchozího zobrazení.
columnconditionstate	columnconditionstate		string	Stav podmínky sloupce
rowid	rowid		integer	Identifikátor řádku.
columnid	columnid		integer	Identifikátor sloupce.
operatorid	operatorid		integer	Identifikátor operátoru.
oprand	oprand		string	Hodnota operandu pro filtr.
logický typ	logicaltype		string	Logický typ filtru.
sheetfiltervaluetypeid	sheetfiltervaluetypeid		string	ID pro typ hodnoty filtru listu.
displaytype	displaytype		string	Typ zobrazení filtru.
sourceColumnId	sourceColumnId		integer	ID zdrojového sloupce pro filtr
scoreConditionTypeid	scoreConditionTypeid		integer	ID pro typ podmínky skóre.
defaultvalue	defaultvalue		string	Výchozí hodnota pro sloupec.
columnwidth	columnwidth		string	Šířka sloupce
název listu	sheetname		string	Název přidruženého listu
název webu	sitename		string	Název webu.
povinný	mandatory		string	Určuje, jestli je sloupec povinný.
allowsearch	allowsearch		string	Určuje, jestli je vyhledávání povolené.
maxchars	maxchars		integer	Maximální počet znaků
allowfieldfromanotherisheet	allowfieldfromanotherisheet		string	Povolí pole z jiného listu.
allowrichhtmltext	allowrichhtmltext		string	Určuje, jestli je povolený formátovaný text HTML.
numberoflines	numberoflines		integer	Počet řádků ve sloupci
displaymethod	displaymethod		string	Metoda použitá k zobrazení sloupce.
includeotheroption	includeotheroption		string	Obsahuje možnost Jiné.
singleormultileselectioninsearch	singleormultileselectioninsearch		string	Určuje typ výběru při hledání.
identifikační číslo	id		string	Jedinečný identifikátor pro volbu."
jmenovka	label		string	Popisek pro volbu
skóre	score		string	Skóre přidružené k výběru
color	color		string	Barevný kód pro výběr.
imageid	imageid		integer	ID přidružené image.
includeinalertpreferences	includeinalertpreferences		string	Zahrnuje předvolby upozornění.
min	min		string	Minimální hodnota sloupce.
max	max		string	Maximální hodnota sloupce.
desetinná místa	decimalplaces		integer	Počet desetinných míst
showthousandseparators	showthousandseparators		string	Zobrazí oddělovače tisíců.
showaspercentage	showaspercentage		string	Zobrazí hodnotu jako procento.
formattype	formattype		string	Určuje typ formátu sloupce.
dateformat	dateformat		string	Definuje formát data sloupce.
defaultdateandtime	defaultdateandtime		string	Nastaví výchozí hodnotu data a času pro sloupec.
sheetlookup	sheetlookup		string	Označuje, jestli je sloupec vyhledáváním na jiném listu.
fielddisplay	fielddisplay		string	Určuje způsob zobrazení pole.
allowmultipleusers	allowmultipleusers		string	Určuje, jestli k poli má přístup více uživatelů.
methodtype	methodtype		string	Definuje typ metody pro sloupec.
listids	sheetids		string	Zobrazí ID listů přidružených ke sloupci.
allowuserstorenamelinks	allowuserstorenamelinks		string	Označuje, jestli uživatelé můžou přejmenovat odkazy ve sloupci.
listid	sheetid		integer	Určuje ID listu.
columnids	columnids		string	Vypíše ID sloupců.
viewid	viewid		integer	Určuje ID zobrazení.
allowmultiplevalues	allowmultiplevalues		string	Určuje, jestli je ve sloupci povoleno více hodnot.
omezitdelete	restrictdelete		string	Určuje, jestli je odstranění pro sloupec omezeno.
displaycolumnnameprefix	displaycolumnnameprefix		string	Nastaví předponu pro zobrazení názvu sloupce.
linkname	linkname		string	Definuje název odkazu přidruženého ke sloupci.
donotcountweekendsonlycountmontofri	donotcountweekendsonlycountmontofri		string	Určuje, jestli jsou víkendy vyloučené při počítání.
currentsheetcolumnid	currentsheetcolumnid		integer	ID aktuálního sloupce listu.
targetsheetcolumnid	targetsheetcolumnid		integer	ID cílového sloupce listu.
vzorec	formula		string	Určuje vzorec použitý ve sloupci.
startvalue	startvalue		integer	Nastaví počáteční hodnotu sloupce.
prefix	prefix		string	Definuje předponu pro hodnoty sloupce.
Postfix	postfix		string	Definuje příponu hodnot sloupců.
minlength	minlength		integer	Určuje minimální délku hodnot sloupců.
lookupglossarysheetid	lookupglossarysheetid		integer	Určuje ID vyhledávacího listu glosáře.
lookupglossarysheetviewid	lookupglossarysheetviewid		integer	Určuje ID zobrazení vyhledávacího listu glosáře.
šířka	width		integer	Nastaví šířku sloupce.
otherscorevalue	otherscorevalue		string	Definuje druhou hodnotu skóre pro sloupec.
importdatafromexternalsource	importdatafromexternalsource		string	Označuje, jestli se data importují z externího zdroje.
analysisengine	analysisengine		string	Určuje modul analýzy použitý pro sloupec.
attachmentcustomfolderid	attachmentcustomfolderid		integer	Určuje VLASTNÍ ID složky pro přílohy.
isattachmentfoldercurrentsite	isattachmentfoldercurrentsite		integer	Označuje, jestli je složka přílohy na aktuálním webu.
singleLineEmailValidation	singleLineEmailValidation		string	Určuje, jestli se použije jednořádkové ověření e-mailu.
jen pro čtení	readonly		string	Označuje, jestli je sloupec jen pro čtení.
virtualColumn	virtualColumn		integer	Určuje, jestli je sloupec virtuální.
allowInlineEditing	allowInlineEditing		string	Označuje, jestli jsou pro sloupec povolené vložené úpravy.
sekvence	sequence		string	Pořadové číslo sloupce
attributecolumnid	attributecolumnid		string	Identifikátor sloupce atributu
value	value		string	Hodnota nezpracovaných dat
date	date		string	datum nezpracovaných dat.
time	time		string	Čas nezpracovaných dat
linkdisplayname	linkdisplayname		string	Zobrazovaný název odkazu
linkdisplayurl	linkdisplayurl		string	Odkaz pro zobrazení adresy URL
identifikační číslo	id		string	ID vyhledávání
e-mail	email		string	E-mailová adresa.
userlookuptype	userlookuptype		string	Typ vyhledávání uživatelů
folderid	folderid		string	ID složky.
docid	docid		string	ID dokumentu.
fromdate	fromdate		string	Od data.
todate	todate		string	K datu.
soubor	file		string	Obsah souboru.
název	name		string	Název přílohy.
pořadí	order		string	Pořadí přílohy.
identifikační číslo	id		integer	Jedinečný identifikátor přílohy.
přípona	extension		string	Přípona souboru.
parentfolderid	parentfolderid		integer	ID nadřazené složky.
filehttplink	filehttplink		string	Odkaz HTTP pro přístup k souboru.
folderpath	folderpath		string	Cesta ke složce obsahující soubor.
folderhttplink	folderhttplink		string	Odkaz HTTP na složku.
nýt	filesize		integer	Velikost souboru v bajtech
redactionStatus	redactionStatus		boolean	Označuje, jestli je soubor redacted.
displayname	displayname		string	Zobrazovaný název přílohy.
siteid	siteid		integer	ID webu přidruženého k příloze
ID záznamu	recordid		string	ID záznamu.
linkname	linkname		string	Název odkazu.
apilink	apilink		string	Odkaz rozhraní API.
httplink	httplink		string	Odkaz HTTP.
colViewPosition	colViewPosition		integer	Pozice sloupce v zobrazení
columntype	columntype		string	Typ sloupce
datum vytvoření	createdDate		date-time	Datum a čas vytvoření sloupce
modifiedDate	modifiedDate		date-time	Datum a čas poslední změny sloupce
injectReferenceColumn	injectReferenceColumn		integer	Odkaz na vložený sloupec
parentColumnID	parentColumnID		integer	Identifikátor nadřazeného sloupce.
reusecolumnidfromisheet	reusecolumnidfromisheet		integer	ID sloupce se znovu použilo ze vstupního listu.
choicelistid	choicelistid		integer	Identifikátor seznamu voleb přidruženého ke sloupci.
upozornění	alerteroption		string	Nastavení možnosti upozornění pro položku
listtypeid	sheettypeid		integer	Identifikátor typu listu.
enableSmartForm	enableSmartForm		string	Aktivuje funkce inteligentního formuláře.
allowDeletedItemsView	allowDeletedItemsView		string	Umožňuje prohlížení odstraněných položek.
allowAllColumnsInCustomView	allowAllColumnsInCustomView		string	Povoluje všechny sloupce ve vlastních zobrazeních.

Návraty

Body: ProgressiveKeyDBO

Vytvořit složku

ID operace:: addFolder

Toto rozhraní API vytvoří novou složku v zadané lokalitě. Umožňuje zadat podrobnosti o složce a zajistit, že se složka vytvoří v dané nadřazené složce.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	Určuje verzi rozhraní API.
Identifikátor dávky	batchid		string	Jedinečný identifikátor dávkové operace.
ID kořenové složky	rootfolderid		string	Jedinečný identifikátor kořenové složky.
ID nadřazené složky	parentfolderid	True	string	Jedinečný identifikátor nadřazené složky, ve které se vytvoří nová složka.
Povolit duplicitní složku	allowduplicatefolder		boolean	Určuje, zda jsou v zadané nadřazené složce povoleny duplicitní složky.
název	name	True	string	Název složky.
popis	description		string	Popis složky.
accessInherited	accessInherited		integer	Označuje, jestli je přístup ke složce zděděný.
batchID	batchID		string	Identifikátor dávky operace.
dmsfolderid	dmsfolderid		string	Identifikátor složky DMS.
dmsParentFolderID	dmsParentFolderID		string	Identifikátor nadřazené složky DMS.
dmscreateddate	dmscreateddate		date-time	Datum vytvoření složky DMS.
dmsmodifiedBy	dmsmodifiedBy		string	Uživatel, který naposledy upravil složku DMS.
dmsdatabasename	dmsdatabasename		string	Název databáze DMS.
dmslink	dmslink		boolean	Určuje, jestli je k dispozici odkaz DMS.
dmslinkby	dmslinkby		string	Uživatel, který propojil složku DMS.
emailmetadata	emailmetadata		string	Metadata e-mailu přidružená ke složce

Návraty

Body: FolderDBOV1

Získání informací o složce

ID operace:: getFolderInfo

Metoda poskytuje podrobnosti o složce daného ID složky.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Verze rozhraní API	version	True	string	verze rozhraní API
ID složky	folderid	True	string	folderID
Informace o stavu	statusinfo		boolean	Parametr statusinfo umožňuje přístup k dalším informacím o složce. Dostupné informace zahrnují sdílený stav, oblíbený stav přihlášeného uživatele.

Návraty

Body: FolderDBOV2

Definice

ErrorDBO

Name	Cesta	Typ
souhrn	summary	string
ref	ref	string
odkaz	link	string

DocumentDBO

Name	Cesta	Typ	Description
docid	docid	string	ID dokumentu.

columns

Name	Cesta	Typ	Description
sloupec	column	array of object
items	column	object

LocationDBO

Name	Cesta	Typ	Description
addressline1	addressline1	string	První řádek adresy.
addressline2	addressline2	string	Druhý řádek adresy.
addressline3	addressline3	string	Třetí řádek adresy.
město	city	string	Město adresy.
stav	state	string	Stav adresy.
země	country	string	Země adresy.
PSČ	postcode	string	Poštovní směrovací číslo adresy.

Uživatelské jméno

Name	Cesta	Typ	Description
title	title	string	Název uživatele.
křestní jméno	firstname	string	Jméno uživatele.
příjmení	lastname	string	Příjmení uživatele.
goesby	goesby	string	preferované jméno uživatele.

MetadataListDBO

Name	Cesta	Typ	Description
název metadat	metadataname	array of string
metadatavalue	metadatavalue	array of string

NameValueLink

Name	Cesta	Typ	Description
identifikační číslo	id	string	ID odkazu
název	name	string	Název odkazu.
value	value	string	Hodnota propojení.

Link

Name	Cesta	Typ	Description
odkaz	link	array of NameValueLink

ProstředíDBO

Name	Cesta	Typ	Description
zkušenost	experience	array of string

GroupsDBO

Name	Cesta	Typ	Description
seskupit	group	array of string

uživatel

Name	Cesta	Typ	Description
ID uživatele	userid	integer	ID uživatele.
následující	following	boolean	Následující.
e-mail	email	string	E-mailová adresa
název	name	UserName
userlink	userlink	string	Odkaz uživatele.
httplink	httplink	string	Odkaz HTTP.
httpavatar	httpavatar	string	Avatar HTTP.
avatar	avatar	integer	Avatar uživatele.
externalid	externalid	string	Externí ID.
datum narození	dateofbirth	string	Datum narození.
telefon	phone	string	Telefonní číslo.
pracovní pozice	jobtitle	string	Pracovní pozice.
mobilní	mobile	string	Číslo mobilního zařízení
oddělení	department	string	Odparment.
stav	status	string	Stav.
organizace	org	string	Organizace.
orgName	orgName	string	Název organizace.
poloha	location	LocationDBO
img	img	string	Obraz.
zkušenosti	experiences	ExperiencesDBO
sociální propojení	sociallinks	Link
customlink	customlink	Link
messaginglink	messaginglink	Link
sekretářka	secretaryname	string	Jméno tajemníka.
sekretářka	secretarymail	string	Sekretářka Mailová.
bio	bio	string	Životopis uživatele.
sourcetype	sourcetype	string	Typ zdroje
speciality	specialities	string	Speciality.
reportsto	reportsto	string	Uživatel, na který aktuální uživatel sestavuje.
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
přípona	suffix	string	Přípona uživatelského jména.
atomlink	atomlink	string	Odkaz Atom přidružený k uživateli
odkaz	link	string	Odkaz přidružený k uživateli
loggeduserlike	loggeduserlike	integer	Počet lajků od přihlášeného uživatele
userName	userName	string	Uživatelské jméno.

users

Name	Cesta	Typ	Description
uživatel	user	array of user

FolderDBOV1

Name	Cesta	Typ	Description
folderid	folderid	string	Jedinečný identifikátor vytvořené složky.

DmsDBO

Name	Cesta	Typ	Description
dmsfolderid	dmsfolderid	string	Identifikátor složky DMS.
dmsParentFolderID	dmsParentFolderID	string	Identifikátor nadřazené složky DMS.
dmscreateddate	dmscreateddate	date-time	Datum vytvoření složky DMS.
dmsmodifiedBy	dmsmodifiedBy	string	Uživatel, který naposledy upravil složku DMS.
dmsdatabasename	dmsdatabasename	string	Název databáze DMS.
dmslink	dmslink	boolean	Určuje, jestli je k dispozici odkaz DMS.
dmslinkby	dmslinkby	string	Uživatel, který propojil složku DMS.

sitegroup

Name	Cesta	Typ
název	name	string
identifikační číslo	id	integer
copypermissionsfrom	copypermissionsfrom	string
zpráva	message	string
typeID	typeID	integer
typ	type	string
numberofusers	numberofusers	string
vytvořil	created	string
modified	modified	string
systemGroupID	systemGroupID	integer
popis	description	string
basicusergroup	basicusergroup	integer

Address

Name	Cesta	Typ	Description
addressid	addressid	string	Jedinečný identifikátor adresy.
addressline1	addressline1	string	První řádek adresy.
addressline2	addressline2	string	Druhý řádek adresy.
addressline3	addressline3	string	Třetí řádek adresy.
město	city	string	Město adresy.
stav	state	string	Stav adresy.
země	country	string	Země adresy.
PSČ	postCode	string	Poštovní směrovací číslo adresy.
poleas	knownas	string	Alternativní jméno nebo přezdívka adresy

IntegrationUserDBO

Name	Cesta	Typ	Description
index	index	integer	Jedinečný index pro uživatele
ID uživatele	userid	integer	Jedinečný identifikátor uživatele.
křestní jméno	firstname	string	Jméno uživatele.
příjmení	lastname	string	Příjmení uživatele.
praktická skupina	practicegroup	string	Procvičte si seskupení, do které uživatel patří.
langcode	langcode	string	Kód jazyka uživatele
localeID	localeID	string	ID národního prostředí uživatele.
publicprofile	publicprofile	string	Veřejný profil uživatele.
pwpid	pwpid	string	ID PWP uživatele.
usertypeid	usertypeid	string	ID typu uživatele.
systemuser	systemuser	string	Příznak uživatele systému.
e-mail	email	string	Email adresu uživatele.
telefon	phone	string	Telefonní číslo uživatele
mobilní	mobile	string	Číslo mobilního zařízení uživatele
oddělení	department	string	Oddělení uživatele.
organizace	org	string	Organizace, do které uživatel patří.
poloha	location	LocationDBO
address	address	Address
zkušenosti	experiences	ExperiencesDBO
sociální propojení	sociallinks	Link
messaginglink	messaginglink	Link
customlink	customlink	Link
img	img	string
reportsto	reportsto	string
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
externalid	externalid	string	Externí ID uživatele
pracovní pozice	jobtitle	string	Pracovní pozice uživatele.
sekretářka	secretaryname	string	Jméno tajemníka uživatele.
sekretářka	secretarymail	string	E-mail sekretáře uživatele.
speciality	specialities	string	Speciality uživatele.
title	title	string	Název uživatele.
goesby	goesby	string	preferované jméno uživatele.
přípona	suffix	string	Přípona uživatelského jména.
atomlink	atomlink	string	Odkaz Atom přidružený k uživateli
bio	bio	string	Životopis uživatele.
dateOfBirth	dateOfBirth	string	Datum narození uživatele.
odkaz	link	string	Odkaz přidružený k uživateli
stav	status	string	Stav uživatele
stavový kód	statuscode	string	Stavový kód uživatele
zpráva	message	string	Zpráva přidružená k uživateli
sourcetype	sourcetype	string	Typ zdroje uživatele
orgid	orgid	string	ID organizace.
ifpartner	ifpartner	string	Příznak partnera.
emaildomain	emaildomain	string	E-mailová doména uživatele
pozvánky	invitationsent	string	Příznak odeslané pozvánky
vytvořil(a)	createdby	string	Uživatel, který záznam vytvořil
createddate	createddate	string	Datum vytvoření záznamu
modifikoval	modifiedby	string	Uživatel, který záznam upravil
modifieddate	modifieddate	string	Datum změny záznamu
lastlogindate	lastlogindate	string	Datum posledního přihlášení
invalidlogins	invalidlogins	string	Počet neplatných pokusů o přihlášení
publicwebsiteprofileid	publicwebsiteprofileid	string	ID profilu veřejného webu.
resetpassworddate	resetpassworddate	string	Datum resetování hesla
avatar	avatar	string	Adresa URL obrázku avataru
následující počet	followingcount	integer	Početsledovaných
followercount	followercount	integer	Počet sledujících.
následující	following	boolean	Následující příznak
role	role	string	Role uživatele
isbasicuser	isbasicuser	string	Základní příznak uživatele.
encryptedUserId	encryptedUserId	string	Šifrované ID uživatele
selfregistered	selfregistered	integer	Příznak zaregistrovaný vlastním držitelem.
registeredWith2FA	registeredWith2FA	string	Příznak registrace dvojúrovňového ověřování
isInternal	isInternal	integer	Příznak interního uživatele
orgName	orgName	string	Název organizace.

site

Name	Cesta	Typ	Description
identifikační číslo	id	integer	Identifikátor webu.
název webu	sitename	string	Název webu.
role	role	string	Role lokality.
sitedescription	sitedescription	string	Popis webu.
enabledmodules	enabledmodules	string	Seznam modulů povolených pro web.
sitefolderID	sitefolderID	string	Identifikátor složky webu.
sitefolderpermission	sitefolderpermission	string	Úroveň oprávnění pro složku webu.
modul	module	ModuleDBO
adminnote	adminnote	string	Poznámky pro správu související s webem
startdate	startdate	string	Počáteční datum operace webu.
enddate	enddate	string	Koncové datum operace webu.
createddate	createddate	string	Datum vytvoření webu.
archiveddate	archiveddate	string	Datum archivace webu.
clientno	clientno	string	Číslo klienta přidružené k lokalitě.
matterno	matterno	string	Číslo hmoty přidružené k webu.
landingpage	landingpage	string	Adresa URL cílové stránky pro web.
odkaz	link	string	Odkaz související s webem.
stav	status	string	Aktuální stav webu.
statusid	statusid	integer	Identifikátor stavu webu.
size	size	string	Velikost webu.
billingnotes	billingnotes	string	Poznámky týkající se fakturace webu
billingnextinvoicedate	billingnextinvoicedate	string	Datum další faktury pro web.
billinglastinvoicedate	billinglastinvoicedate	string	Datum poslední faktury pro web.
filepagecount	filepagecount	string	Celkový počet stránek souborů na webu.
maxpagecount	maxpagecount	string	Maximální povolený počet stránek pro soubory na webu.
sitehttplink	sitehttplink	string	Odkaz HTTP na web.
isSyncable	isSyncable	integer	Označuje, jestli je web synchronizovaný.
enforceusergroups	enforceusergroups	string	Skupiny uživatelů vynucované pro web.
csvSiteCategory	csvSiteCategory	string	Kategorie webu ve formátu CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage	string	Název webu ve výchozím jazyce.
viditelný	visible	integer	Označuje, jestli je web viditelný.
siteLogoName	siteLogoName	string	Název souboru s logem webu.
siteLogoFileSize	siteLogoFileSize	integer	Velikost souboru loga webu.
siteLogoHeight	siteLogoHeight	integer	Výška loga webu.
siteLogoWidth	siteLogoWidth	integer	Šířka loga webu.
siteStatus	siteStatus	integer	Stavový kód webu.
applySiteTerms	applySiteTerms	integer	Označuje, jestli se použijí termíny webu.
siteTerm	siteTerm	string	Podmínky použité na web.
termType	termType	integer	Typ podmínek použitých na web.
nextLoginSiteTerms	nextLoginSiteTerms	integer	Určuje, jestli se při příštím přihlášení vyžadují podmínky webu.
defaultSiteTermsEnable	defaultSiteTermsEnable	integer	Označuje, jestli jsou povolené výchozí termíny webu.
advancedQAPermission	advancedQAPermission	integer	Rozšířená úroveň oprávnění pro kontrolu kvality pro web.
isInternal	isInternal	integer	Označuje, jestli je web interní.
Psm	psm	integer	Identifikátor Product Service Manageru.
siteLabelDisplay	siteLabelDisplay	string	Popisek zobrazení webu.
allowSiteAdministration	allowSiteAdministration	integer	Označuje, jestli je povolená správa webu.
siteLevelPasswordEnable	siteLevelPasswordEnable	integer	Povolení ochrany heslem na úrovni webu
siteLevelPasscodeEnable	siteLevelPasscodeEnable	integer	Povolení ochrany hesla na úrovni lokality
passcodeUsingAuthApp	passcodeUsingAuthApp	integer	Označuje, jestli ověřování pomocí hesla používá ověřovací aplikaci.
sitePassword	sitePassword	string	Heslo přidružené k webu.
ipRestrictionEnable	ipRestrictionEnable	integer	Povolení omezení PROTOKOLU IP pro přístup k lokalitě
availableIP	availableIP	string	Čárkami oddělený seznam IP adres povolených pro přístup k webu.
highqDrive	highqDrive	integer	Označuje, jestli je povolená integrace Jednotky HighQ.
applySiteHomePage	applySiteHomePage	integer	Pokud chcete použít vlastní domovskou stránku pro web.
siteHomePage	siteHomePage	string	Adresa URL vlastní domovské stránky webu
siteHomePageType	siteHomePageType	integer	Typ domovské stránky
nextLoginSiteHomePage	nextLoginSiteHomePage	integer	Pokud chcete nastavit další přihlášení na domovskou stránku webu.
applyDisplayContent	applyDisplayContent	integer	Chcete-li použít nastavení obsahu pro zobrazení.
displayContent	displayContent	string	Obsah, který se má zobrazit na webu
rssSecurity	rssSecurity	integer	Úroveň zabezpečení informačního kanálu RSS.
šifrované heslo	encryptedPassword	integer	Označuje, jestli je heslo webu zašifrované.
availableIPRangeCSV	availableIPRangeCSV	string	Čárkami oddělený seznam rozsahů IP adres povolených pro přístup k webu.
siteModuleID	siteModuleID	integer	Identifikátor modulu webu.
icalSecurity	icalSecurity	integer	Úroveň zabezpečení informačního kanálu iCal.
defaultDisplayContent	defaultDisplayContent	string	Výchozí obsah, který se má zobrazit na webu.
defaultEmailAlert	defaultEmailAlert	integer	Povolení výchozích e-mailových upozornění
excelReportFooter	excelReportFooter	integer	Obsahuje zápatí v excelových sestavách.
excelReportFooterText	excelReportFooterText	string	Text, který se má zobrazit v zápatí excelových sestav.
oznámeníMLJSON	announcementMLJSON	string	Oznámení ve formátu JSON pro web
typ šablony	templateType	integer	Typ šablony použité pro web
templateLicence	templateLicence	integer	Typ licence pro šablonu webu.
openChannelAppID	openChannelAppID	string	ID aplikace pro integraci s otevřeným kanálem
itemid	itemid	integer	Identifikátor položky přidružené k webu.
sitemetadatasheetid	sitemetadatasheetid	integer	ID listu metadat přidruženého k webu.
osobní web	mysite	boolean	Označuje, jestli se jedná o osobní web uživatele.
lastaccesseddate	lastaccesseddate	string	Datum a čas posledního přístupu k webu
defaultViewerMetaDataTab	defaultViewerMetaDataTab	integer	Výchozí karta metadat pro prohlížeč webu
documentMetadataViewId	documentMetadataViewId	integer	metadata dokumentu pro identifikátor zobrazení.
folderMetadataViewId	folderMetadataViewId	integer	metadata složky pro identifikátor zobrazení.
docSort	docSort	integer	Pořadí řazení dokumentů.
folderSort	folderSort	integer	Pořadí řazení složek.
defaultFolderRenderView	defaultFolderRenderView	integer	Určuje výchozí režim zobrazení pro složky.
isTaskAttachmentDefault	isTaskAttachmentDefault	integer	Výchozí umístění pro přílohy úkolů
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId	integer	Jedinečný identifikátor složky určené jako výchozí umístění pro přílohy úkolů.
oblíbený	favourite	string	stav oblíbených.
enabledocumentredaction	enabledocumentredaction	boolean	Určuje, jestli je pro web povolená redakce dokumentu.
mentiongroups	mentiongroups	integer	Uvedené skupiny.
enablefilerelationships	enablefilerelationships	boolean	Určuje, jestli jsou povolené relace souborů.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel	integer	Úroveň oprávnění potřebná ke správě relací souborů.

ModuleDBO

Name	Cesta	Typ
domov	home	HomeDBO
aktivita	activity	ActivityDBO
dokument	document	DocumentDBO
blog	blog	BlogDBO
wikiweb	wiki	WikiDBO
úkol	task	TaskDBO
událost	event	EventDBO
isheet	isheet	ISheetDBO
Qa	qa	QaDBO
lid	people	PeopleDBO
contractexpress	contractexpress	ContractExpressDBO

HomeDBO

Name	Cesta	Typ	Description
povolit	enable	string	Povolení stavu pro HomeDBO

ActivityDBO

Name	Cesta	Typ	Description
povolit	enable	string	Povolení stavu pro ActivityDBO
mikroblog	microblog	string	Obsah mikroblogu přidružený k ActivityDBO.

BlogDBO

Name	Cesta	Typ	Description
blogTitle	blogTitle	string	Název blogového příspěvku.
blogContent	blogContent	string	Obsah blogového příspěvku
showComment	showComment	integer	zobrazit komentář.
Seznam tagů	tagList	array of string	Seznam značek přidružených k blogu
stav	status	integer	stav příspěvku na blogu.
siteID	siteID	integer	Identifikátor přidružené lokality.
autor	author	string	Autor blogu.
categoryList	categoryList	array of string	Kategorie přiřazené k blogovém příspěvku
notificationTypeID	notificationTypeID	integer	Identifikátor typu oznámení.
zpráva	message	string	Obsah zprávy související s blogem
messageCode	messageCode	integer	Kód přidružený ke zprávě
Externí ID	externalID	string	Externí identifikátor propojený s blogem
Datum publikování	publishDate	string	Datum publikování blogu.
processtype	processtype	string	Typ procesu přidružený k blogu
povolit	enable	string	Povolte stav pro BlogDBO.

WikiDBO

Name	Cesta	Typ	Description
wikiid	wikiid	integer	Jedinečný identifikátor wikiwebu
currentversionid	currentversionid	integer	Identifikátor aktuální verze wikiwebu
parentwikiid	parentwikiid	integer	Identifikátor nadřazeného wikiwebu
wikititle	wikititle	string	Název wikiwebu
wikikontent	wikicontent	string	Obsah wikiwebu
showcomment	showcomment	integer	Označuje, jestli jsou povoleny komentáře.
createddate	createddate	string	Datum vytvoření wikiwebu
modifieddate	modifieddate	string	Datum poslední změny wikiwebu
seznam značek	taglist	string	Čárkami oddělený seznam značek přidružených k wikiwebu
wikipath	wikipath	string	Cesta pro přístup k wikiwebu
wikidraftid	wikidraftid	integer	Identifikátor konceptu verze wikiwebu
drafttype	drafttype	string	Typ konceptu přidruženého k wikiwebu
stav	status	integer	Aktuální stav wikiwebu
wikiversionid	wikiversionid	integer	Identifikátor verze wikiwebu.

TaskDBO

Name	Cesta	Typ	Description
index	index	string	Index nebo identifikátor úkolu.
parenttaskid	parenttaskid	integer	Identifikátor nadřazeného úkolu
taskid	taskid	integer	Jedinečný identifikátor úkolu.
title	title	string	Názevúkoluhoho
popis	description	string	Podrobný popis úkolu
duedate	duedate	string	Termín splnění dokončení úkolu
startdate	startdate	string	Počáteční datum, kdy byl úkol zahájen.
mattermaptaskid	mattermaptaskid	string	Identifikátor propojování s úkolem mapování hmoty.
typ	type	string	Zadejte nebo kategorii úkolu.
dependenton	dependenton	string	Úkoly, na které tento úkol závisí.
daysfromdependent	daysfromdependent	string	Počet dnů od závislého úkolu
ignoreweekend	ignoreweekend	integer	Označuje, jestli se při plánování ignorují víkendy.
duration	duration	integer	Doba trvání dokončení úkolu
prostředek	resource	string	Zdroje přiřazené k úkolu.

EventDBO

Name	Cesta	Typ	Description
eventTitle	eventTitle	string	Název události.
eventContent	eventContent	string	Obsah události.
showComment	showComment	integer	Označuje, jestli jsou pro událost povoleny komentáře.
Seznam tagů	tagList	array of string	Seznam značek přidružených k události
stav	status	integer	Aktuální stav události
siteID	siteID	integer	Identifikátor webu.
kontakt	contact	string	Kontaktní informace pro událost.
categoryList	categoryList	array of string	Kategorie, pod kterými je událost uvedená.
notificationTypeID	notificationTypeID	integer	Typ oznámení související s událostí.
zpráva	message	string	Zpráva události.
messageCode	messageCode	integer	Kód zprávy události.
Externí ID	externalID	string	Externí identifikátor.
startDate	startDate	string	Počáteční datum události.
datum ukončení	endDate	string	Koncové datum události.
startTime	startTime	string	Čas zahájení události.
endTime	endTime	string	Čas ukončení události.
poloha	location	string	Umístění události.
autor	author	string	Autor události.
processtype	processtype	string	Doba zpracování události.
povolit	enable	string	Povolte událost.

ISheetDBO

Name	Cesta	Typ	Description
identifikační číslo	id	integer	Jedinečný identifikátor listu iSheet.
title	title	string	Název iSheetu
popis	description	string	Popis isheetu
stav	status	string	Stav isheetu
accesstype	accesstype	string	Přístupový typ isheetu
typ	type	string	Typ listu.
viewlink	viewlink	string	Odkaz pro zobrazení iSheetu
možnosti povolení	allowsections	string	Určuje, jestli jsou oddíly povolené.
allowlookup	allowlookup	string	Určuje, jestli jsou vyhledávací pole povolená.
displayisheet	displayisheet	string	Zobrazit možnosti pro iSheet.
searchasdefaultview	searchasdefaultview	string	Označuje, jestli je hledání výchozím zobrazením.
enableversion	enableversion	string	Příznak s povolenou verzí
enablesheetalerter	enablesheetalerter	string	Příznak pro povolení upozornění listu
alertercondition	alertercondition	string	Podmínky pro aktivaci výstrah
overrideitemmodifieddate	overrideitemmodifieddate	string	Přepsat příznak datum změny
enablebulkinsertupdate	enablebulkinsertupdate	string	Povolte hromadné vložení nebo aktualizaci.
popisy polí	fielddescriptions	string	Popisy polí pro iSheet.
enablerowlocking	enablerowlocking	string	Povolte uzamykání na úrovni řádků.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled	string	Zkrácení víceřádkového textového příznaku
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval	string	Omezení znaků pro víceřádkové zkrácení
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse	string	Povolit opakované použití hodnot seznamu voleb
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse	string	Povolit opakované použití hodnot seznamu skóre
allowIsheetComments	allowIsheetComments	string	Povolit komentáře v iSheetu
shareRecordsLimit	shareRecordsLimit	integer	Omezení záznamů, které se můžou sdílet
shareRecordsLimitEnabled	shareRecordsLimitEnabled	integer	Povolený limit sdílených složek záznamů
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing	string	Povolte sdílení formulářů pro přidávání záznamů.
recordcount	recordcount	string	Aktuální počet záznamů.
listtypeid	sheettypeid	integer	ID typu listu iSheet

QaDBO

Name	Cesta	Typ	Description
povolit	enable	string	Povolte funkci kontroly kvality.

PeopleDBO

Name	Cesta	Typ	Description
osoba	person	array of PersonDBO

PersonDBO

Name	Cesta	Typ	Description
ID uživatele	userid	integer	ID uživatele.
e-mail	email	string	e-mailová adresa.
httpavatar	httpavatar	string	Adresa URL protokolu HTTP avataru.
avatar	avatar	string	Obrázek avataru
userlink	userlink	string	Odkaz na profil uživatele
httplink	httplink	string	Odkaz HTTP na profil uživatele
telefon	phone	string	Telefonní číslo.
mobilní	mobile	string	Číslo mobilního zařízení
oddělení	department	string	Oddělení uživatele.

ContractExpressDBO

Name	Cesta	Typ	Description
povolit	enable	string	Povolení integrace Contract Express

FolderDBOV2

Name	Cesta	Typ	Description
název	name	string	Název složky.
popis	description	string	Popis složky
parentFolderID	parentFolderID	integer	ID nadřazené složky
accessInherited	accessInherited	integer	Stav dědičnosti přístupu
batchID	batchID	string	Identifikátor dávky
DMS	dms	DmsDBO
identifikační číslo	id	integer	ID složky.
odkaz	link	string	Odkaz na složku
createddate	createddate	string	Termín vyhotovení.
modifieddate	modifieddate	string	Datum změny.
podřízený	child	integer	Podřízené složky.
počet souborů	filecount	integer	Počet souborů.
vytvořil(a)	createdby	UserDBO
modifikoval	modifiedby	UserDBO
folderid	folderid	integer	ID složky.
dmsfolderid	dmsfolderid	string	Identifikátor složky DMS.
siteid	siteid	integer	ID webu
poloha	location	string	Umístění složky
oprávnění	permission	PermissionDBO
contentstatus	contentstatus	integer	Stav obsahu.
automatické číslování	autonumbering	string	Konfigurace automatického číslování
složek	foldersize	string	Velikost složky
sharedstatus	sharedstatus	integer	Stav sdílení
favoritestatus	favouritestatus	integer	Oblíbený stav.
foldertype	foldertype	string	Typ složky.
Identifikátor položky	itemId	integer	ID položky.
folderMetadataSheetId	folderMetadataSheetId	integer	Metadata složek ID listu.

UserDBO

Name	Cesta	Typ	Description
křestní jméno	firstname	string	Křestní jméno.
příjmení	lastname	string	Příjmení.
e-mail	email	string	E-mailová adresa.
ID uživatele	userid	integer	ID uživatele.

PermissionDBO

Name	Cesta	Typ	Description
pohled	view	integer	Zobrazit oprávnění.
úprava	edit	integer	Upravit oprávnění.
odstranit	delete	integer	Odstranit oprávnění.
addEditAllFiles	addEditAllFiles	integer	Přidat nebo upravit všechna oprávnění k souborům
správce	admin	integer	Oprávnění správce.
viewAllFiles	viewAllFiles	integer	Zobrazit všechna oprávnění k souborům
disableSave	disableSave	integer	zakázat uložit oprávnění.
uploadFile	uploadFile	integer	nahrání souboru Oprávnění.
updateFile	updateFile	integer	aktualizovat soubor Oprávnění.
deleteFile	deleteFile	integer	Odstranit oprávnění k souboru.

ProgressiveKeyDBO

Name	Cesta	Typ	Description
progresivní klíč	progressivekey	string	Klíč pro progresivní operace.
siteid	siteid	integer	Identifikátor webu.
progressivekeystatus	progressivekeystatus	string	Stav progresivního klíče.
ID uživatele	userid	integer	Identifikátor uživatele.
responsebody	responsebody	string	Text odpovědi.
zpráva	message	string	Obsah zprávy.
messagecode	messagecode	string	Kód přidružený ke zprávě
integrationResponseDBO	integrationResponseDBO	IntegrationResponseDBO
columns	columns	ColumnErrorsDBO
items	items	ItemErrorsDBO
importisheettemplate	importisheettemplate	importISheetTemplateDBO
chyba	error	ErrorDBO
typ obsahu	contentType	string	Typ obsahu
Neúspěšnéenty	failedEntities	integer	Počet neúspěšných entit
downloadlink	downloadlink	string	Odkaz na stažení obsahu
příloha	attachment	Attachment
odkaz	link	string	Přidružený odkaz.
documentid	documentid	integer	Identifikátor dokumentu.
progresskey	progresskey	string	Klíč průběhu sledování
progresskeystatus	progresskeystatus	string	Stav klíče průběhu

IntegrationResponseDBO

Name	Cesta	Typ	Description
integrationResponseUsersObject	integrationResponseUsersObject	IntegrationResponseUsersObject
Neúspěšnéenty	failedEntities	integer	Počet entit, které selhaly při zpracování
successEntities	successEntities	integer	Počet úspěšně zpracovaných entit

IntegrationResponseUsersObject

Name	Cesta	Typ	Description
uživatel	user	array of IntegrationUserDBO

ColumnErrorsDBO

Name	Cesta	Typ	Description
sloupec	column	array of ColumnErrorDBO
Neúspěšnéenty	failedEntities	integer	Počet entit, které selhaly kvůli chybám sloupce
successEntities	successEntities	integer	Počet úspěšně zpracovaných entit

ColumnErrorDBO

Name	Cesta	Typ	Description
index	index	integer	Umístění indexu sloupce s chybou
columnid	columnid	integer	Jedinečný identifikátor sloupce s chybou
název	name	string	Název sloupce s chybou
stav	status	string	Stav označující chybový stav
stavový kód	statuscode	string	Kód představující stav chyby
zpráva	message	string	Podrobná chybová zpráva

ItemErrorsDBO

Name	Cesta	Typ	Description
položka	item	array of ItemErrorDBO
Neúspěšnéenty	failedEntities	integer	Počet entit, které selhaly kvůli chybám položek
successEntities	successEntities	integer	Počet entit, které byly úspěšně zpracovány bez ohledu na chyby položek

ItemErrorDBO

Name	Cesta	Typ	Description
index	index	integer	Umístění indexu položky s chybou
columns	columns	ColumnErrorsDBO
itemid	itemid	string	Jedinečný identifikátor položky s chybou
externalid	externalid	string	Externí identifikátor přidružený k položce
identifikační číslo	id	string	Interní identifikátor položky.
název	name	string	Název položky s chybou
stav	status	string	Stav označující chybový stav
stavový kód	statuscode	string	Kód představující stav chyby
zpráva	message	string	Podrobná chybová zpráva
successdeletedcount	successdeletedcount	integer	Počet úspěšně odstraněných entit
počet selhání	failurecount	integer	Počet entit, které selhaly při zpracování
Neúspěšnéenty	failedEntities	integer	Počet entit, které selhaly kvůli chybám položek
successEntities	successEntities	integer	Počet úspěšně zpracovaných entit

importISheetTemplateDBO

Name	Cesta	Typ	Description
linkedtemplateid	linkedtemplateid	integer	Identifikátor propojené šablony.
aliasname	aliasname	string	Název aliasu pro šablonu
linkedisheet	linkedisheet	string	Identifikátor propojeného vstupního listu.
importdata	importdata	string	Data, která se mají importovat ze šablony.
appendisheetname	appendisheetname	string	Název listu pro připojení dat.
templateparametergroups	templateparametergroups	ISheetTemplateParameterGroups
templateSheetIdMap	templateSheetIdMap	object
ID šablony	templateId	integer	Identifikátor šablony.
templateTitle	templateTitle	string	Název šablony
identifikátory viewID	viewIDs	string	Seznam ID zobrazení oddělený čárkami

ISheetTemplateParameterGroups

Name	Cesta	Typ	Description
templateparametergroup	templateparametergroup	array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Name	Cesta	Typ	Description
templateruleid	templateruleid	integer	Skupina parametrů šablony Isheet.
templateparameter	templateparameter	array of ISheetTemplateParameter

ISheetTemplateParameter

Name	Cesta	Typ	Description
identifikační číslo	id	integer	Identifikátor parametru šablony isheet.
název	name	string	Název parametru šablony isheet.
data	data	string	data parametru šablony isheet.

Attachment

Name	Cesta	Typ	Description
soubor	file	string	Obsah souboru.
název	name	string	Název přílohy.
pořadí	order	string	Pořadí přílohy.
identifikační číslo	id	integer	Jedinečný identifikátor přílohy.
přípona	extension	string	Přípona souboru.
parentfolderid	parentfolderid	integer	ID nadřazené složky.
filehttplink	filehttplink	string	Odkaz HTTP pro přístup k souboru.
folderpath	folderpath	string	Cesta ke složce obsahující soubor.
folderhttplink	folderhttplink	string	Odkaz HTTP na složku.
nýt	filesize	integer	Velikost souboru v bajtech
redactionStatus	redactionStatus	boolean	Označuje, jestli je soubor redacted.
displayname	displayname	string	Zobrazovaný název přílohy.
siteid	siteid	integer	ID webu přidruženého k příloze

Sdílet prostřednictvím

HighQ (Preview)

HighQ

Přehled

Autentizace

Operace konektoru

Modul ISheet

Rozhraní API pro prostředky dokumentů

Rozhraní API pro správu ISheetu

Operace uživatelů

Správa dokumentů a webů

Začínáme

Parametry a nastavení

Řešení potíží a omezení

Další zdroje

Licencování a podpora

Limity omezování

Akce

Aktualizace skupiny webů

Parametry

Návraty

Aktualizace webu

Parametry

Archivovat uživatele

Parametry

Načtení informací o souboru

Parametry

Návraty

Načtení seznamu položek iSheetu

Parametry

Návraty

Načtení seznamu složek

Parametry

Návraty

Načtení seznamu uživatelů

Parametry

Návraty

Načtení sloupců iSheet

Parametry

Návraty

Odeslání souboru

Parametry

Přesunout dokumenty

Parametry

Přidat uživatele

Parametry

Návraty

Přidat web

Parametry

Návraty

Přidání existující skupiny na web

Parametry

Návraty

Vytvoření položky iSheetu

Parametry

Návraty

Vytvořit složku

Parametry

Návraty

Získání informací o složce

Parametry

Návraty

Definice

ErrorDBO

DocumentDBO

columns

LocationDBO

Uživatelské jméno

MetadataListDBO

NameValueLink

Link

ProstředíDBO

GroupsDBO

uživatel

users

FolderDBOV1

DmsDBO

sitegroup

Address

IntegrationUserDBO