Megosztás:

HighQ (előzetes verzió)

Ez az összekötő biztonságos és hitelesített hozzáférést biztosít a HighQ API-khoz, így zökkenőmentesen integrálható az együttműködési és tartalomkezelési képességek az egyéni munkafolyamatokba és alkalmazásokba. Támogatja a dokumentumautomatizálást, az adatszinkronizálást és a munkafolyamatok vezénylését – lehetővé teszi a jogi és szakmai szolgáltatási csapatok számára a műveletek egyszerűsítését, a manuális munkamennyiség csökkentését és a termelékenység növelését.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service Class Régiók
Copilot Studio prémium Az összes Power Automate-régió, kivéve a következőket:
     - USA kormánya (GCC)
     - Amerikai kormány (GCC High)
     - A 21Vianet által üzemeltetett China Cloud
     - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások Standard Az összes Logic Apps-régió , kivéve a következőket:
     - Azure Government-régiók
     - Azure China-régiók
     - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások prémium Az összes Power Apps-régió , kivéve a következőket:
     - USA kormánya (GCC)
     - Amerikai kormány (GCC High)
     - A 21Vianet által üzemeltetett China Cloud
     - Amerikai Védelmi Minisztérium (DoD)
Power Automate prémium Az összes Power Automate-régió, kivéve a következőket:
     - USA kormánya (GCC)
     - Amerikai kormány (GCC High)
     - A 21Vianet által üzemeltetett China Cloud
     - Amerikai Védelmi Minisztérium (DoD)
Érintkezés
Név Highq
URL https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Email highq-support@thomsonreuters.com
Összekötő metaadatai
Kiadó Thomson Reuters Incorporated
Webhely https://legal.thomsonreuters.com/en/products/highq
Adatvédelmi irányelvek https://www.thomsonreuters.com/en/privacy-statement
Kategóriák Együttműködés; Tartalom és fájlok

HighQ

Áttekintés

A HighQ zökkenőmentes, biztonságos, hitelesített hozzáférést biztosít a HighQ API-khoz. Ez az összekötő zökkenőmentes interakciót tesz lehetővé a különböző HighQ-szolgáltatásokkal, például az ISheet-modullal, a dokumentum-erőforrás API-kkal, az ISheet Felügyeleti API-kkal és a felhasználói műveletekkel. Célja, hogy megkönnyítse a HighQ Együttműködési platformmal való integrációt, olyan funkciókat kínálva, mint az iSheet-elemek lekérése és létrehozása, a dokumentumfájlok kezelése és a felhasználói fiókok felügyelete.

  • Összekötő verziója: 1.0.0
  • Cím: HighQ
  • Leírás: Ez az összekötő zökkenőmentes, biztonságos és hitelesített hozzáférést biztosít a HighQ API-khoz.
  • Érintkezés:

Authentication

Az összekötő dinamikus környezeti változókat használ a biztonságos kapcsolat érdekében:

  • Gazdagép: @environmentVariables("highqt_host")
  • Alap elérési út: /@environmentVariables("highqt_instancename")/api
  • Ügyfélazonosító:@environmentVariables("highqt_clientid")
  • Titkos ügyfélkód:@environmentVariables("highqt_clientsecret")

A részletes hitelesítési eljárásokért tekintse meg a HighQ technikai támogatási portálját, vagy forduljon a HighQ ügyfélszolgálatához.

Összekötőműveletek

ISheet-modul

  • iSheet-elemek lekérése
    GET /{version}/isheet/{isheetid}/items
    Lekéri a megadott iSheet elemeinek listáját.

  • iSheet-elemek létrehozása
    POST /{version}/isheet/{isheetid}/items
    Új elemek beszúrása egy iSheetbe több iSheet támogatásával és az állapotkövetés progresszív kulcsokkal.

Dokumentumerőforrás API-k

  • Fájladatok lekérése
    GET /{version}/files/{fileid}
    Részletes információkat kér le egy adott fájlról a HighQ Együttműködési platformon.

  • Fájl feltöltése
    POST /{version}/files/content
    Feltölt egy fájlt egy megadott mappába, és támogatja az adattömbök feltöltését a Content-Range fejléc megadásakor.

  • Mappalista lekérése
    GET /{version}/folders/{folderid}/items
    Lekéri a megadott mappában lévő mappák listáját, amely támogatja a rendezést és a lapozást.

ISheet Admin API

  • iSheet-oszlopok lekérése
    GET /{version}/isheets/admin/{isheetid}/columns
    Egy adott iSheet oszlopkonfigurációit kéri le.

Felhasználói műveletek

  • Felhasználók lekérése
    GET /{version}/users
    Lekéri azon felhasználók listáját, amelyek támogatják a szűrést, a lapozást és a részletes felhasználói szerepköröket.

  • Új felhasználó hozzáadása
    POST /{version}/users
    Új felhasználói fiókot hoz létre kiterjesztett attribútumokkal és érvényesítéssel.

  • Felhasználó archiválása
    DELETE /{version}/users/{userid}
    Meglévő felhasználó archiválása a rendszerből.

Dokumentum- és webhelykezelés

  • Mappa létrehozása
    POST /{version}/folders
    Új mappát hoz létre egy megadott szülőmappa alatt.

  • Dokumentumok áthelyezése
    PUT /{version}/files/move
    Egy vagy több fájl áthelyezése egy mappából egy másikba ugyanazon a webhelyen belül.

  • Helykezelési műveletek:

    • Meglévő csoport hozzáadása a webhelyhez: POST /{version}/sites/{siteid}/groups/{groupid}
    • Webhelycsoport frissítése: PUT /{version}/sites/{siteid}/groups/{groupid}
    • Új webhely hozzáadása: POST /{version}/sites

Első lépések

  1. Konfiguráció:

    • Határozza meg a környezeti változókat highqt_host és highqt_instancename a Power Platform-környezetet.

  2. Hitelesítés:

    • Kövesse a HighQ által biztosított irányelveket az API-kérések biztonságos hitelesítésének konfigurálásához.

  3. Használat:

    • Importálja a HighQ-t a Power Platform-példányba.
    • Szükség szerint használja a rendelkezésre álló műveleteket. Útmutatásért tekintse meg a fenti műveletösszegzőket.

Paraméterek és beállítások

  • Elérési út paraméterei:
    Adja meg a szükséges paramétereket, például version, isheetid, fileid, folderidés userid szükség szerint.

  • Lekérdezési paraméterek:
    Az olyan választható paraméterek, mint a sheetviewid, sortcolumnidlimit, és offset az API-válaszok finomításához érhetők el.

  • Törzsparaméterek:
    A kérelemtörzset igénylő műveleteknél (például iSheet-elemek vagy felhasználók létrehozása) győződjön meg arról, hogy a kérés megfelel a megadott sémáknak (például isheetDBO: , FolderDBOvagy IntegrationUserDBO).

Hibaelhárítás és korlátozások

  • Hibakódok:
    A szabványos HTTP-állapotkódok a műveletek során használatosak:

    • 200 sikeres műveletekhez
    • 401 jogosulatlan hozzáféréshez
    • 403 tiltott vagy érvényesítési hibák esetén
    • 405 érvénytelen HTTP-metódusok esetén
    • 500 belső kiszolgálóhibák esetén
      Részletes hibaleírásokért tekintse meg az egyes API-dokumentációkat.

  • Korlátozások:
    Egyes végpontok alapértelmezett korlátokkal (például 100 rekord alapértelmezett limit értékével) rendelkezhetnek. A nagyméretű adathalmazok rendezéséhez és szűréséhez további paraméterekre lehet szükség.

További források

Részletesebb információkért és a kiterjesztett dokumentációért tekintse meg a következő témakört:

Licencelés és támogatás

Licencelési részletek és technikai támogatás:

Szabályozási korlátok

Name Hívások Megújítási időszak
API-hívások kapcsolatonként 100 60 másodperc

Műveletek

Az iSheet elem létrehozása

Ez az API-hívás az iSheet-elem beszúrására szolgál. Több iSheet is támogatott.

Ha egy iSheet-elem állapotát progresszív kulcs alapján szeretné lekérni, hívja meg az API POST /api/3/progressivekeystatus/{progressive_key} parancsot.

pl. POST /api/{version}/progressivekeystatus/{progressive_key}

NévTípusDescription
progressive_keyLánc A művelet állapotának ellenőrzéséhez szükséges kulcs.

Válasz

<progressivekeyresponse>
 \t<elemek>
  \t\t<elem>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<üzenet>Rekord hozzáadása sikeresen</üzenet>
  \t\t</item>
  \t\t<elem>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<üzenet>Rekord hozzáadása sikeresen</üzenet>
  \t\t</item>
 \t</items>
</progressivekeyresponse>
Dokumentumok áthelyezése

Ez az API több fájlt helyez át egy mappából egy másikba ugyanazon a webhelyen belül.
Felhasználó archiválása

Ez az API-hívás egy felhasználó rendszeren belüli archiválására szolgál.

Hibakódok

Összefoglalás Ref Code (v4 előtt) Ref Code (V4)

A következő felhasználók nem léteznek a rendszeren belül

 110 110

Felhasználói azonosítóra van szükség

 109 109

A felhasználói azonosító nem a megfelelő formátumban van

 113 113

A felhasználó azonosítójának hossza nem lehet hosszabb 50 karakternél

 N/A 304


JIRA jegy: https://dev.highq.com/jira/browse/COL-67441
Felhasználó hozzáadása

Ezzel az API-hívással új felhasználót vehet fel a rendszerbe.
Megjegyzés:
1. Az alábbi új mezők támogatása hozzáadva
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. A címcímke hozzáadva az API 4-es verziójához

1

Összefoglalás Ref Code (v4 előtt) Ref Code (V4)

E-mail-cím megadása kötelező

 101 101

Érvénytelen e-mail-cím

 104 104

Az utónév megadása kötelező

 102 102

Az utónév maximálisan megengedett karaktereinek 1 és 100 közöttinek kell lenniük

 102 352

A titkár/asszisztens e-mail-címe érvénytelen

 104 353

Az állapotnak aktívnak vagy inaktívnak kell lennie

 116 116

A megadott részleg legfeljebb 256 karakter hosszúságú lehet

 N/A 354

A megadott ifpartner attribútum érvénytelen

 N/A 355

A megadott systemuser attribútum érvénytelen

 N/A 356

A megadott usertypeid attribútum érvénytelen

 N/A 357

A megadott langcode attribútum érvénytelen

 N/A 358

A megadott sourcetype attribútum érvénytelen. Az érvényes értékek a System, az Active Directory vagy a System alapértelmezett értékei.

 N/A 359

Adjon meg érvényes telefonszámot   

 N/A 360

Adjon meg érvényes telefonszámot a következő formátumban: {countrycode}  ${areacode}${number}.

 N/A 361

Adjon meg érvényes mobilszámot {countrycode}${number} formátumban.

 N/A 362

Adjon meg egy érvényes office phone országkódot

 N/A 363

Az office phone országkódja legfeljebb 4 számjegyből áll

 N/A 364

Adjon meg egy érvényes irodai telefon körzetszámot

 N/A 365

Az irodai telefon körzetszáma legfeljebb 5 számjegyből áll

 N/A 366

Az Office-telefonszám legfeljebb 15 számjegyből áll

 N/A 368

Adjon meg érvényes mobiltelefon-országkódot

 N/A 369

A mobiltelefon országkódja legfeljebb 4 számjegyből áll

 N/A 372

Adjon meg érvényes mobilszámot

 N/A 373

A mobiltelefonszám legfeljebb 20 számjegyből áll

 N/A 374

A tartomány nem létezik

 105 105

Az e-mail már létezik a rendszerben

 111 111

Szervezet említése önállóan regisztrált tartomány esetén   

 187 187

Szervezet említése kivételes tartomány esetén   

 115 115

A szervezeti azonosító nem a megfelelő formátumban van   

 112 112

A szervezet nem létezik

 106 106

A tartomány más szervezetben is létezik

 114 114

Érvénytelen a megadott címazonosító

 N/A 308

A közösségi hivatkozás neve nem található a rendszerben.

 N/A 375

A közösségi hivatkozás neve kötelező

 N/A 376

A közösségi kapcsolat értéke kötelező

 N/A 377

A közösségi kapcsolat értékének maximális karaktereinek 1 és 500 közöttinek kell lenniük

 N/A 378

Adja meg az egyéni hivatkozás nevét

 N/A 379

A szükséges egyéni hivatkozásérték

 N/A 380

Az egyéni hivatkozásnév maximális karaktereinek 1 és 500 közöttinek kell lenniük

 N/A 381

Az egyéni hivatkozás értékének maximális karaktereinek 1 és 500 közöttinek kell lenniük

 N/A 382

Az üzenethivatkozás nevének megadása kötelező

 N/A 383

Az üzenethivatkozás neve nem található a rendszerben

 N/A 384

Az üzenethivatkozás értéke kötelező   

 N/A 385

Az üzenethivatkozás értékének maximális karaktereinek 1 és 500 közöttinek kell lenniük

 N/A 386

A közösségi hivatkozás le van tiltva

 N/A 408

Az üzenethivatkozás le van tiltva

 N/A 409

Az egyéni hivatkozás le van tiltva

 N/A 410

JIRA jegy: https://dev.highq.com/jira/browse/COL-65685
Felhasználói lista lekérése

Felhasználók listájának lekérése: Ez az API lekéri a felhasználók listáját a rendszerből. ## Főbb funkciók – Felhasználói adatok lekérése több szűrési beállítással – Támogatja a lapozást limit a offset legutóbbi verziókban bevezetett új lekérdezési paraméterekkel és mezőkkel – Strukturált válasz felhasználói szerepkörökkel és attribútumokkal ## Új lekérdezési paraméterek (Version-Specific) – Bevezetés a V12-ben: - systemAdminSearch: Ha be van állítva 1, csak a rendszergazdai szerepkörrel rendelkező felhasználókat adja vissza. - A V18-ban bevezetett: – useridVesszővel tagolt értékeket (CSV) fogad el. ## Válasz törzsének frissítései – Új mezők hozzáadva: - emaildomain, , orginvitationsent, createdby, createddate, modifiedby,modifieddate - ifpartner , lastlogindate, invalidlogins,externalidpublicwebsiteprofileid - systemuser , resetpassworddate, , usertypeid,avatarpracticegroup - langcodepublicprofile , dateOfBirth ## Címformátum módosítása (a V11-ből) – A location címke át lett nevezve address konzisztenciaként. - Példaválasz: 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> ## Felhasználói szerepkörök (az API V11+-ban vezették be) – Példaválasz: 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> ## Korlátok és eltolások – Korlát viselkedése: - Alapértelmezett: 100 ha nincs megadva érték. - Az összes rekord visszaadására használható -1 . - Ha az érték kisebb, mint -1az alapértelmezett 100érték. - Eltolás viselkedése: – Alapértelmezett: 0 ha nincs megadva érték. - Ha az eltolás meghaladja az összes rekordot, az alapértelmezett érték vissza lesz kapcsolva.0 ## Új szerepkörök – V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Hibakódok | Összefoglalás | Ref Code (V4 előtt) | Ref Code (V4) | |---------|----------------------|--------------| | Érvénytelen bemenet a felhasználói állapothoz (AKTÍV, ARCHIVÁLT, INAKTÍV) | 147 | 147 | A szervezet azonosítója érvénytelen | N/A | 260 | | Érvénytelen neverinvited érték (igaz/hamis) | N/A | 387 | | Érvénytelen neverlogin érték (igaz/hamis) | N/A | 388 | | Érvénytelen groupids érték | N/A | 214 | | Érvénytelen notingroup érték (igaz/hamis) | N/A | 389 | | Érvénytelen ordertype (támogatott: név, szervezet, státusz stb.) | N/A | 289 | | Érvénytelen orderby (támogatott: asc, desc) | N/A | 290 | | Érvénytelen offset érték | 138 | 138 | | Érvénytelen limit érték | 137 | 137 | ## Megjegyzések – A V13-tól kezdődően ez az API minden felhasználó számára nyitva áll (korábban csak a rendszergazdák számára). – A V18-tól kezdődően a userregistered2FA mező azt jelzi, hogy egy felhasználó regisztrált-e 2FA-ra. --- Ez a leírás a Swagger 2.0 sémaformázást követi, és az Egyéni összekötő séma leírás mezőjébe kell helyezni.
Fájl feltöltése

Ez az API-hívás feltölt egy fájlt egy adott mappába a HighQ Együttműködési platformon. Támogatja az adattömbök feltöltését a Content-Range fejléc megadásakor.
Fájladatok lekérése

Ez az API-hívás részletes információkat kér le egy adott fájlról a HighQ Együttműködési platformról.
ISheet-elemek listájának lekérése

Ez az API-hívás lekéri a megadott iSheetben található elemek listáját.
iSheet-oszlopok lekérése

Ez az API-hívás lekéri a megadott iSheethez társított oszlopokat. Ez a funkció az API 3- és újabb verziójában támogatott.
Mappa létrehozása

Ez az API létrehoz egy új mappát a megadott webhelyen belül. Lehetővé teszi a mappaadatok megadását, és biztosítja, hogy a mappa az adott szülőmappában legyen létrehozva.
Mappaadatok lekérése

A metódus a megadott mappaazonosító mappaadatait tartalmazza.

Mappák listájának lekérése

Ez az API-hívás lekéri a megadott mappában található mappák listáját. A "korlát" paraméter beállítja a visszaadandó elemek maximális számát, az "eltolás" paraméter pedig az adatlekérés kiindulási helyét. Az alapértelmezett értékek akkor lesznek alkalmazva, ha ezek a paraméterek nincsenek megadva, és a rendszer növekvő sorrendben adja vissza a mappákat a létrehozás dátuma szerint.
Meglévő csoport hozzáadása a webhelyhez

Ez az API-metódus hozzáad egy meglévő rendszercsoportot a webhelyhez.
Ezt az API-t kiterjesztették a meglévő rendszerszintű felhasználói csoportok (rendszer/szervezet típusú) hozzáadására a webhelyen.

Webhely frissítése

Ezzel az API-végpontkal frissítheti egy meglévő webhely adatait. Az API ugyanazokat a mezőket támogatja, amelyeket a Webhely API létrehozásakor használnak.

Ez a módszer több anyagszámot is támogat, amelyek az API 10-es verziójával hozzáadhatóak a webhelyhez. A "matternos" címke több számsort jelöl, és olvashatóan vagy nem.

18-tól kezdődően: kategóriákra (webhelycélra) van szükség. Ha a webhely célja rejtett, megjelenik egy üzenet; ellenkező esetben a rejtett webhelycélok nem lesznek hozzáadva a webhelyhez.

A webhelytulajdonos mostantól más felhasználókhoz is hozzárendelhető, de a webhely résztvevőinek kell lenniük, és nagyobb szerepkörrel kell rendelkezniük, mint a webhelygazdák.

18-es verzió: a webhely tulajdonosa hozzáadhat más felhasználókat a webhelyhez.

Az API 19-es verziójától kezdve egy új, customPages nevű modult vezetünk be, amely szorosan kapcsolódik az otthoni modulhoz. Ha az otthoni modul értéke Igaz, a customPages értéknek igaznak kell lennie, és fordítva.

Vegye figyelembe, hogy a webhely válaszának lekérésében szereplő összes tulajdonság/elem nem frissíthető/beilleszthető. Az alábbi táblázatból megtudhatja, hogy mely írásvédett, frissíthető vagy beszúrható elemek olvashatók.
Webhely hozzáadása

Ezzel az API-val hozzon létre egy új webhelyet. A helyobjektum csak a létrehozási hely felületén látható attribútumokat támogatja.

Ehhez az API-hoz a helynév (és az ASP szintjén konfigurált kötelező mezők, ha vannak ilyenek) szükségesek egy új webhely létrehozásához.

A "modul" címke különböző, a webhelyen konfigurálni kívánt modult jelöl, ahogy az a kérelemattribútumokban is látható.
Webhely létrehozása sablonból a "sitetemplateid" címke megadásával
     - A 7-es verziónál kisebb verzió esetén, ha a kérelemben nincs megadva egy modul ("a modul" címke nem kerül átadásra), a sablonmodul konfigurálása megtörténik. Ha a modulcímke konfigurációval rendelkezik, az figyelembe veszi és a kérésben megadott módon konfigurálja (a sablonmodul konfigurációjának használata helyett)
     - A 7-es verziónál nagyobb verzió esetén, ha egy modult ("modul" címkét adnak át), vagy nem szerepel a kérelemben, a sablonmodul konfigurálása megtörténik.

Ez a módszer nem támogatja a webhelykép feltöltését ebben a hívásban, a webhelyikon támogatása külön hívásként lesz biztosítva.
A metódushívás egy meglévő kategóriaazonosítót vár. A kategóriaazonosítót a hívó alkalmazásnak a Webhelykategóriák felületére irányuló korábbi hívással kell beszereznie. Ha a kérelemben nincsenek kategóriák, a rendszer alapértelmezés szerint egyetlen kategóriát sem ad hozzá (tényleges kategória nélkül).

A webhely kezdő és záró dátumának "dd MMM yyyy" formátumban kell lennie, és NEM UTC. Az API-ügyfél mindig tényleges dátumot kér.

A "landingpage" alapértelmezett értéke "fájlok (gyökérmappa)".
A "landingpage" három különböző szövegre vagy azonosításra számít a Fájl modulhoz. A lehetséges értékek a következők:
- fájlok (gyökérmappa)
- fájlok (legutóbbi tevékenység)
- fájlok (speciális keresés)
A metódus implementációja mostantól támogatja (5.1-től) a többnyelvű helynevet. Az API 6-os vagy újabb <webhelyneve> a kérelem törzsében jelenik meg a felhasználói beállítások sorrendje alapján. Az API 5-ös vagy régebbi <webhelyneve> az alapértelmezett brit angol nyelvet fogja jelölni.
<A sitenametranslations> minden nyelven a webhelyneveket fogja jelölni (amely az "Object maga API" további címkéje lesz az 5.1-től kezdődően) API 6-os vagy újabb verziójában, a kérelem törzsében mindkét címkét küldik, például a helynevet< és >a sitenametranslationst<, >majd ellenőrizni kell az értékeket, például <a webhelynévnek> meg kell egyeznie a megfelelő <fordítási> címkével a felhasználó nyelvi beállításainak megfelelően. A sablonból létrehozott API 7-es vagy újabb verziója a forrássablonból származó modulokat követi, és figyelmen kívül hagyja a kérelem törzsében küldött modullistát.

A metódus implementációja mostantól támogatja a webhely sablonból való létrehozását a "sitetemplateid" címke megadásával (régi megközelítés)

Kérjük, vegye figyelembe, hogy a webhely sablonból való létrehozásának támogatása az API használatával a jövőben elavulttá válik. Ha sablonból szeretne webhelyet létrehozni, használja az új API Create site from template (/sites/templates/{templateid}/site) nevű webhelyet, amely egy hosszú lekérdezési API (amely támogatja a hosszú ideig futó kéréseket)

Ez a módszer több anyagszámot is támogat, amelyek az API 10-es verziójával hozzáadhatóak a webhelyhez. A "matternos" címke több számsort jelöl, és olvashatóan vagy nem. A régebbi (10-es verziónál kisebb) egyszámú "matterno" a helyszínen létező több anyagszám első anyagszámát fogja tükrözni.

18-tól kezdődően: kategóriákra (webhelycélra) van szükség. Ha a webhely célja rejtett, megjelenik egy üzenet; ellenkező esetben a rejtett webhelycélok nem lesznek hozzáadva a webhelyhez.

A 17-es verzióig: a webhely tulajdonosa a bejelentkezett felhasználó; más felhasználók nem vehetők fel.

18-es verzió: a webhely tulajdonosa hozzáadhat más felhasználókat a webhelyhez.

Az API 19-es verziójától kezdve egy új modult vezetnek be "customPages" néven, amely szorosan kapcsolódik az otthoni modulhoz. Tehát ha az otthoni modul értéke Igaz, a customPages értéke igaz lesz, és fordítva.
Webhelycsoport frissítése

Ez az API-metódus frissíti a webhely egy meglévő csoportjának nevét.
Ezt az API-t kiterjesztették a webhely meglévő alapszintű felhasználói csoportjának nevének frissítésére.

Az iSheet elem létrehozása

Műveletazonosító:
insertISheetItems

Ez az API-hívás az iSheet-elem beszúrására szolgál. Több iSheet is támogatott.

Ha egy iSheet-elem állapotát progresszív kulcs alapján szeretné lekérni, hívja meg az API POST /api/3/progressivekeystatus/{progressive_key} parancsot.

pl. POST /api/{version}/progressivekeystatus/{progressive_key}

NévTípusDescription
progressive_keyLánc A művelet állapotának ellenőrzéséhez szükséges kulcs.

Válasz

<progressivekeyresponse>
 \t<elemek>
  \t\t<elem>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<üzenet>Rekord hozzáadása sikeresen</üzenet>
  \t\t</item>
  \t\t<elem>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<üzenet>Rekord hozzáadása sikeresen</üzenet>
  \t\t</item>
 \t</items>
</progressivekeyresponse>

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

Az api verziója
iSheet-azonosító
 isheetid True integer

Az iSheet azonosítója
Lapnézet azonosítója
 sheetviewid integer

Az iSheet nézet azonosítója (nem kötelező)
azonosító
 id integer

Isheet-azonosító.
title
 title string

A lap címe.
leírás
 description string

A lap leírása.
állapot
 status string

A lap állapota.
accesstype
 accesstype string

A lap hozzáférési típusa.
típus
 type string

A lap típusa.
viewlink
 viewlink string

URL-hivatkozás a lap megtekintéséhez.
allowsections
 allowsections string

Azt jelzi, hogy engedélyezettek-e szakaszok.
allowlookup
 allowlookup string

Azt jelzi, hogy engedélyezve van-e a keresés.
displayisheet
 displayisheet string

Megjelenítési adatlap.
searchasdefaultview
 searchasdefaultview string

Alapértelmezett nézetként állítja be a keresést.
enableversion
 enableversion string

Verzió engedélyezése.
enablesheetalerter
 enablesheetalerter string

Aktiválja a lapriasztást.
alertercondition
 alertercondition string

Riasztások aktiválásának feltétele.
overrideitemmodifieddate
 overrideitemmodifieddate string

Az over ride az elem módosított dátuma.
enablebulkinsertupdate
 enablebulkinsertupdate string

Tömeges beszúrási frissítés engedélyezése.
mezőleírók
 fielddescriptions string

mezők leírása.
enablerowlocking
 enablerowlocking string

Engedélyezi a sorzárolást.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Engedélyezi a karakterkorlát csonkolását többsoros szövegek esetében.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

A csonkítás karakterkorlátját állítja be.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

Lehetővé teszi a választható listaértékek újbóli felhasználását.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

Lehetővé teszi a pontszámlista értékeinek újbóli felhasználását.
allowIsheetComments
 allowIsheetComments string

Megjegyzések engedélyezése a munkalapon.
shareRecordsLimit
 shareRecordsLimit integer

A megosztott rekordok korlátozása.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

A megosztási rekord korlátjának engedélyezése.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Engedélyezi a rekordbejegyzési űrlap megosztását.
allowViewBaseRendering
 allowViewBaseRendering string

Lehetővé teszi a nézetek alapszintű renderelését.
oszlop
 column object
rekordszám
 recordcount string

Rekordok teljes száma.
viewId
 viewId integer

A nézet egyedi azonosítója.
siteId
 siteId integer

A társított webhely azonosítója.
siteName
 siteName string

A webhely neve.
sheetName
 sheetName string

A lap neve.
viewName
 viewName string

A nézet neve.
sheetId
 sheetId integer

A lap azonosítója.
szekvencia
 sequence string

A fejlécoszlop sorszáma.
columnValue
 columnValue string

A fejlécoszlop értéke.
columnTypeId
 columnTypeId string

Az oszloptípus azonosítója.
columnId
 columnId string

Az oszlop egyedi azonosítója.
columnTypeAlias
 columnTypeAlias string

Az oszloptípus aliasneve.
itemsequence
 itemsequence string

Az elem sorszáma.
itemid
 itemid string

Az elem egyedi azonosítója.
externalid
 externalid string

Az elemhez társított külső azonosító.
oszlopazonosító
 columnid integer

Az oszlop egyedi azonosítója
név
 name string

Az oszlop neve
típus
 type integer

Az oszlop adattípusa.
systemgeneratedtype
 systemgeneratedtype string

Rendszer által létrehozott típusadatok.
section
 section integer

Szakaszszám, ahol az oszlop található.
leírás
 description string

Az oszlop részletes leírása.
addtodefaultview
 addtodefaultview string

Azt jelzi, hogy az oszlop hozzáadva van-e az alapértelmezett nézethez.
columnconditionstate
 columnconditionstate string

Az oszlop állapotának állapota.
sorazonosító
 rowid integer

A sor azonosítója.
oszlopazonosító
 columnid integer

Az oszlop azonosítója.
operátorazonosító
 operatorid integer

Az operátor azonosítója.
oprand
 oprand string

A szűrő operandusértéke.
logikai típus
 logicaltype string

A szűrő logikai típusa.
sheetfiltervaluetypeid
 sheetfiltervaluetypeid string

A lapszűrő értéktípusának azonosítója.
displaytype
 displaytype string

A szűrő megjelenítési típusa.
sourceColumnId
 sourceColumnId integer

A szűrő forrásoszlop-azonosítója.
scoreConditionTypeid
 scoreConditionTypeid integer

A pontszám feltételtípusának azonosítója.
defaultvalue
 defaultvalue string

Az oszlop alapértelmezett értéke.
columnwidth
 columnwidth string

Az oszlop szélessége.
munkalapnév
 sheetname string

A társított lap neve.
webhelynév
 sitename string

A webhely neve.
kötelező
 mandatory string

Azt jelzi, hogy az oszlop kötelező-e.
allowsearch
 allowsearch string

Megadja, hogy engedélyezve van-e a keresés.
maxchars
 maxchars integer

Karakterek maximális száma.
allowfieldfromanotherisheet
 allowfieldfromanotherisheet string

Egy másik lap mezőinek engedélyezése.
allowrichhtmltext
 allowrichhtmltext string

Megadja, hogy engedélyezett-e rich HTML-szöveg.
számsorok
 numberoflines integer

Az oszlopban lévő sorok száma.
displaymethod
 displaymethod string

Az oszlop megjelenítésére használt módszer.
includeotheroption
 includeotheroption string

Tartalmaz egy "Egyéb" lehetőséget.
singleormultileselectioninsearch
 singleormultileselectioninsearch string

A keresésben a kijelölés típusát adja meg.
azonosító
 id string

A választás egyedi azonosítója."
címke
 label string

Címke a választáshoz.
pont
 score string

A választáshoz társított pontszám.
color
 color string

Színkód a választáshoz.
imageid
 imageid integer

A társított kép azonosítója.
includeinalertpreferences
 includeinalertpreferences string

Tartalmazza a riasztási beállításokat.
min
 min string

Az oszlop minimális értéke.
max
 max string

Az oszlop maximális értéke.
decimális hely
 decimalplaces integer

Tizedesjegyek száma.
showthousandseparators
 showthousandseparators string

Ezres elválasztójelet jelenít meg.
showaspercentage
 showaspercentage string

Százalékértékként jeleníti meg az értéket.
formattype
 formattype string

Megadja az oszlop formátumtípusát.
dateformat
 dateformat string

Meghatározza az oszlop dátumformátumát.
defaultdateandtime
 defaultdateandtime string

Az oszlop alapértelmezett dátum- és időértékének beállítása.
sheetlookup
 sheetlookup string

Azt jelzi, hogy az oszlop egy másik lap keresése-e.
fielddisplay
 fielddisplay string

Meghatározza a mező megjelenítésének módját.
allowmultipleusers
 allowmultipleusers string

Megadja, hogy több felhasználó is hozzáfér-e a mezőhöz.
metódustípus
 methodtype string

Meghatározza az oszlop metódustípusát.
lapazonosítók
 sheetids string

Az oszlophoz társított lapok azonosítóit sorolja fel.
allowuserstorenamelinks
 allowuserstorenamelinks string

Azt jelzi, hogy a felhasználók átnevezhetik-e az oszlop hivatkozásait.
lapazonosító
 sheetid integer

A lap azonosítóját adja meg.
oszlopazonosítók
 columnids string

Az oszlopok azonosítóit sorolja fel.
viewid
 viewid integer

A nézet azonosítóját adja meg.
allowmultiplevalues
 allowmultiplevalues string

Azt jelzi, hogy több érték is engedélyezett-e az oszlopban.
restrictdelete
 restrictdelete string

Megadja, hogy a törlés korlátozva van-e az oszlopban.
displaycolumnnameprefix
 displaycolumnnameprefix string

Beállítja az oszlopnév megjelenítéséhez szükséges előtagot.
hivatkozásnév
 linkname string

Meghatározza az oszlophoz társított hivatkozás nevét.
donotcountweekendsonlycountmontofri
 donotcountweekendsonlycountmontofri string

Azt adja meg, hogy a hétvégék ki vannak-e zárva a számolásból.
currentsheetcolumnid
 currentsheetcolumnid integer

Az aktuális laposzlop azonosítója.
targetsheetcolumnid
 targetsheetcolumnid integer

A céllap oszlop azonosítója.
képlet
 formula string

Az oszlopra alkalmazott képletet adja meg.
startvalue
 startvalue integer

Beállítja az oszlop kezdőértékét.
prefix
 prefix string

Meghatározza az oszlopértékek előtagjait.
Postfix
 postfix string

Meghatározza az oszlopértékek utótagjait.
minlength
 minlength integer

Az oszlopértékek minimális hosszát adja meg.
lookupglossarysheetid
 lookupglossarysheetid integer

A keresési szószedet lap azonosítóját adja meg.
lookupglossarysheetviewid
 lookupglossarysheetviewid integer

A keresési szószedet lap nézetazonosítóját adja meg.
szélesség
 width integer

Beállítja az oszlop szélességét.
otherscorevalue
 otherscorevalue string

Meghatározza az oszlop másik pontszámértékét.
importdatafromexternalsource
 importdatafromexternalsource string

Azt jelzi, hogy az adatok külső forrásból származnak-e.
analysisengine
 analysisengine string

Az oszlophoz használt elemzőmotort adja meg.
attachmentcustomfolderid
 attachmentcustomfolderid integer

Megadja a mellékletek egyéni mappaazonosítóját.
isattachmentfoldercurrentsite
 isattachmentfoldercurrentsite integer

Azt jelzi, hogy a mellékletmappa az aktuális helyen található-e.
singleLineEmailValidation
 singleLineEmailValidation string

Megadja, hogy egysoros e-mail-ellenőrzés van-e alkalmazva.
readonly
 readonly string

Azt jelzi, hogy az oszlop írásvédett-e.
virtualColumn
 virtualColumn integer

Megadja, hogy az oszlop virtuális-e.
allowInlineEditing
 allowInlineEditing string

Azt jelzi, hogy engedélyezett-e beágyazott szerkesztés az oszlopban.
szekvencia
 sequence string

Az oszlop sorszáma.
attribútumcolumnid
 attributecolumnid string

Attribútumoszlop azonosítója.
value
 value string

A nyers adatok értéke.
date
 date string

a nyers adatok dátuma.
time
 time string

A nyers adatok ideje.
linkdisplayname
 linkdisplayname string

Megjelenítendő hivatkozás neve.
linkdisplayurl
 linkdisplayurl string

URL-hivatkozás megjelenítése.
azonosító
 id string

Keresési azonosító
e-mail
 email string

Email cím.
userlookuptype
 userlookuptype string

Felhasználókeresés típusa.
mappaazonosító
 folderid string

Mappaazonosító.
docid
 docid string

Dokumentumazonosító.
fromdate
 fromdate string

Dátumtól kezdve.
todate
 todate string

A mai napig.
fájl
 file string

A fájl tartalma.
név
 name string

A melléklet neve.
sorrend
 order string

A melléklet sorrendje.
azonosító
 id integer

A melléklet egyedi azonosítója.
bővítmény
 extension string

Fájlkiterjesztés.
parentfolderid
 parentfolderid integer

A szülőmappa azonosítója.
filehttplink
 filehttplink string

HTTP-hivatkozás a fájl eléréséhez.
folderpath
 folderpath string

A fájlt tartalmazó mappa elérési útja.
folderhttplink
 folderhttplink string

HTTP-hivatkozás a mappára.
fájlméret
 filesize integer

A fájl mérete bájtban.
redactionStatus
 redactionStatus boolean

Azt jelzi, hogy a fájl újra ki van-e léptetve.
displayname
 displayname string

A melléklet megjelenítendő neve.
siteid
 siteid integer

A melléklethez társított webhely azonosítója.
rekord azonosító
 recordid string

Rekordazonosító.
hivatkozásnév
 linkname string

Hivatkozás neve.
apilink
 apilink string

API Link.
httplink
 httplink string

HTTP-hivatkozás.
colViewPosition
 colViewPosition integer

Az oszlop pozíciója a nézetben.
oszloptípus
 columntype string

Az oszlop típusa.
létrehozás dátuma
 createdDate date-time

Az oszlop létrehozásának dátuma és időpontja.
modifiedDate
 modifiedDate date-time

Az oszlop utolsó módosításának dátuma és időpontja.
injectReferenceColumn
 injectReferenceColumn integer

Hivatkozás injektált oszlopra
parentColumnID
 parentColumnID integer

A szülőoszlop azonosítója.
reusecolumnidfromisheet
 reusecolumnidfromisheet integer

Egy bemeneti lapból újra felhasználható oszlopazonosító.
choicelistid
 choicelistid integer

Az oszlophoz társított választási lista azonosítója.
alerteroption
 alerteroption string

Az elem riasztási beállításának beállítása.
sheettypeid
 sheettypeid integer

A laptípus azonosítója.
enableSmartForm
 enableSmartForm string

Aktiválja az intelligens űrlapfunkciókat.
allowDeletedItemsView
 allowDeletedItemsView string

Lehetővé teszi a törölt elemek megtekintését.
allowAllColumnsInCustomView
 allowAllColumnsInCustomView string

Engedélyezi az egyéni nézetekben lévő összes oszlopot.

Válaszok

Törzs
ProgressiveKeyDBO

Dokumentumok áthelyezése

Műveletazonosító:
moveDocuments

Ez az API több fájlt helyez át egy mappából egy másikba ugyanazon a webhelyen belül.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

Az API-verziót adja meg.
Célmappa azonosítója
 targetfolder True string

Annak a célmappának az egyedi azonosítója, ahová a fájlokat áthelyezi.
fileidCSV
 fileidCSV string

Az áthelyezendő fájlazonosítók vesszővel tagolt listája.

Felhasználó archiválása

Műveletazonosító:
deleteUser

Ez az API-hívás egy felhasználó rendszeren belüli archiválására szolgál.

Hibakódok

Összefoglalás Ref Code (v4 előtt) Ref Code (V4)

A következő felhasználók nem léteznek a rendszeren belül

 110 110

Felhasználói azonosítóra van szükség

 109 109

A felhasználói azonosító nem a megfelelő formátumban van

 113 113

A felhasználó azonosítójának hossza nem lehet hosszabb 50 karakternél

 N/A 304


JIRA jegy: https://dev.highq.com/jira/browse/COL-67441

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

az API verziója
Felhasználói azonosító
 userid True string

felhasználói azonosító

Felhasználó hozzáadása

Műveletazonosító:
createUser

Ezzel az API-hívással új felhasználót vehet fel a rendszerbe.
Megjegyzés:
1. Az alábbi új mezők támogatása hozzáadva
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. A címcímke hozzáadva az API 4-es verziójához

1

Összefoglalás Ref Code (v4 előtt) Ref Code (V4)

E-mail-cím megadása kötelező

 101 101

Érvénytelen e-mail-cím

 104 104

Az utónév megadása kötelező

 102 102

Az utónév maximálisan megengedett karaktereinek 1 és 100 közöttinek kell lenniük

 102 352

A titkár/asszisztens e-mail-címe érvénytelen

 104 353

Az állapotnak aktívnak vagy inaktívnak kell lennie

 116 116

A megadott részleg legfeljebb 256 karakter hosszúságú lehet

 N/A 354

A megadott ifpartner attribútum érvénytelen

 N/A 355

A megadott systemuser attribútum érvénytelen

 N/A 356

A megadott usertypeid attribútum érvénytelen

 N/A 357

A megadott langcode attribútum érvénytelen

 N/A 358

A megadott sourcetype attribútum érvénytelen. Az érvényes értékek a System, az Active Directory vagy a System alapértelmezett értékei.

 N/A 359

Adjon meg érvényes telefonszámot   

 N/A 360

Adjon meg érvényes telefonszámot a következő formátumban: {countrycode}  ${areacode}${number}.

 N/A 361

Adjon meg érvényes mobilszámot {countrycode}${number} formátumban.

 N/A 362

Adjon meg egy érvényes office phone országkódot

 N/A 363

Az office phone országkódja legfeljebb 4 számjegyből áll

 N/A 364

Adjon meg egy érvényes irodai telefon körzetszámot

 N/A 365

Az irodai telefon körzetszáma legfeljebb 5 számjegyből áll

 N/A 366

Az Office-telefonszám legfeljebb 15 számjegyből áll

 N/A 368

Adjon meg érvényes mobiltelefon-országkódot

 N/A 369

A mobiltelefon országkódja legfeljebb 4 számjegyből áll

 N/A 372

Adjon meg érvényes mobilszámot

 N/A 373

A mobiltelefonszám legfeljebb 20 számjegyből áll

 N/A 374

A tartomány nem létezik

 105 105

Az e-mail már létezik a rendszerben

 111 111

Szervezet említése önállóan regisztrált tartomány esetén   

 187 187

Szervezet említése kivételes tartomány esetén   

 115 115

A szervezeti azonosító nem a megfelelő formátumban van   

 112 112

A szervezet nem létezik

 106 106

A tartomány más szervezetben is létezik

 114 114

Érvénytelen a megadott címazonosító

 N/A 308

A közösségi hivatkozás neve nem található a rendszerben.

 N/A 375

A közösségi hivatkozás neve kötelező

 N/A 376

A közösségi kapcsolat értéke kötelező

 N/A 377

A közösségi kapcsolat értékének maximális karaktereinek 1 és 500 közöttinek kell lenniük

 N/A 378

Adja meg az egyéni hivatkozás nevét

 N/A 379

A szükséges egyéni hivatkozásérték

 N/A 380

Az egyéni hivatkozásnév maximális karaktereinek 1 és 500 közöttinek kell lenniük

 N/A 381

Az egyéni hivatkozás értékének maximális karaktereinek 1 és 500 közöttinek kell lenniük

 N/A 382

Az üzenethivatkozás nevének megadása kötelező

 N/A 383

Az üzenethivatkozás neve nem található a rendszerben

 N/A 384

Az üzenethivatkozás értéke kötelező   

 N/A 385

Az üzenethivatkozás értékének maximális karaktereinek 1 és 500 közöttinek kell lenniük

 N/A 386

A közösségi hivatkozás le van tiltva

 N/A 408

Az üzenethivatkozás le van tiltva

 N/A 409

Az egyéni hivatkozás le van tiltva

 N/A 410

JIRA jegy: https://dev.highq.com/jira/browse/COL-65685

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

az API verziója
index
 index integer

A felhasználó egyedi indexe.
userid
 userid integer

A felhasználó egyedi azonosítója.
keresztnév
 firstname string

A felhasználó utóneve.
vezetéknév
 lastname string

A felhasználó vezetékneve.
practicegroup
 practicegroup string

Gyakorlatcsoport, amelyhez a felhasználó tartozik.
langcode
 langcode string

A felhasználó nyelvkódja.
localeID
 localeID string

A felhasználó területi azonosítója.
publicprofile
 publicprofile string

A felhasználó nyilvános profilja.
pwpid
 pwpid string

A felhasználó PWP-azonosítója.
usertypeid
 usertypeid string

Felhasználótípus azonosítója.
rendszerfelhasználó
 systemuser string

Rendszerfelhasználói jelző.
e-mail
 email string

Email felhasználó címe.
phone
 phone string

A felhasználó telefonszáma.
mobil
 mobile string

A felhasználó mobilszáma.
osztály
 department string

A felhasználó részlege.
szervezet
 org string

Szervezet, amelyhez a felhasználó tartozik.
címsor1
 addressline1 string

A cím első sora.
címvonal2
 addressline2 string

A cím második sora.
addressline3
 addressline3 string

A cím harmadik sora.
city
 city string

A cím városa.
state
 state string

A cím állapota.
country
 country string

A cím országa.
irányítószám
 postcode string

A cím irányítószáma.
addressid
 addressid string

A cím egyedi azonosítója.
címsor1
 addressline1 string

A cím első sora.
címvonal2
 addressline2 string

A cím második sora.
addressline3
 addressline3 string

A cím harmadik sora.
city
 city string

A cím városa.
state
 state string

A cím állapota.
country
 country string

A cím országa.
irányítószám
 postCode string

A cím irányítószáma.
ismertek
 knownas string

A cím alternatív neve vagy beceneve.
élmény
 experience array of string
azonosító
 id string

Hivatkozás azonosítója
név
 name string

Hivatkozás neve.
value
 value string

Hivatkozás értéke.
azonosító
 id string

Hivatkozás azonosítója
név
 name string

Hivatkozás neve.
value
 value string

Hivatkozás értéke.
azonosító
 id string

Hivatkozás azonosítója
név
 name string

Hivatkozás neve.
value
 value string

Hivatkozás értéke.
img
 img string
reportsto
 reportsto string
metaadatnév
 metadataname array of string
metaadatérték
 metadatavalue array of string
csoport
 group array of string
externalid
 externalid string

A felhasználó külső azonosítója.
jobtitle
 jobtitle string

A felhasználó beosztása.
secretaryname
 secretaryname string

A felhasználó titkárának neve.
secretarymail
 secretarymail string

A felhasználó titkárának e-mail-címe.
Specialitásokat
 specialities string

A felhasználó különlegességei.
title
 title string

A felhasználó címe.
goesby
 goesby string

a felhasználó preferált neve.
toldalék
 suffix string

A felhasználó nevének utótagja.
atomlink
 atomlink string

A felhasználóhoz társított atomhivatkozás.
bio
 bio string

A felhasználó életrajza.
dateOfBirth
 dateOfBirth string

A felhasználó születési dátuma.
hivatkozás
 link string

A felhasználóhoz társított hivatkozás.
állapot
 status string

A felhasználó állapota.
állapotkód
 statuscode string

A felhasználó állapotkódja.
üzenet
 message string

A felhasználóhoz társított üzenet.
sourcetype
 sourcetype string

A felhasználó forrástípusa.
orgid
 orgid string

Szervezeti azonosító.
ifpartner
 ifpartner string

Partnerjelölő.
e-mail-cím
 emaildomain string

A felhasználó e-mail-tartománya.
invitationsent
 invitationsent string

Meghívó elküldve jelző.
létrehozta
 createdby string

A rekordot létrehozó felhasználó.
createddate
 createddate string

A rekord létrehozásának dátuma.
módosítva
 modifiedby string

A rekordot módosító felhasználó.
módosítottdátum
 modifieddate string

A rekord módosításának dátuma.
lastlogindate
 lastlogindate string

Az utolsó bejelentkezés dátuma.
invalidlogins
 invalidlogins string

Érvénytelen bejelentkezési kísérletek száma.
publicwebsiteprofileid
 publicwebsiteprofileid string

Nyilvános webhelyprofil azonosítója.
resetpassworddate
 resetpassworddate string

A jelszó alaphelyzetbe állításának dátuma.
megtestesülés
 avatar string

Avatar kép URL-címe.
followingcount
 followingcount integer

Követett felhasználók száma.
followercount
 followercount integer

Követők száma.
alábbi
 following boolean

Következő jelölő.
szerepkör
 role string

A felhasználó szerepköre.
isbasicuser
 isbasicuser string

Egyszerű felhasználói jelző.
encryptedUserId
 encryptedUserId string

Titkosított felhasználói azonosító.
önregisztrált
 selfregistered integer

Ön által regisztrált jelző.
registeredWith2FA
 registeredWith2FA string

Kéttényezős hitelesítés regisztrációs jelzője.
isBelső
 isInternal integer

Belső felhasználói jelző.
orgName
 orgName string

A szervezet neve.

Válaszok

Törzs
IntegrationUserDBO

Felhasználói lista lekérése

Műveletazonosító:
getAllSystemUsers

Felhasználók listájának lekérése: Ez az API lekéri a felhasználók listáját a rendszerből. ## Főbb funkciók – Felhasználói adatok lekérése több szűrési beállítással – Támogatja a lapozást limit a offset legutóbbi verziókban bevezetett új lekérdezési paraméterekkel és mezőkkel – Strukturált válasz felhasználói szerepkörökkel és attribútumokkal ## Új lekérdezési paraméterek (Version-Specific) – Bevezetés a V12-ben: - systemAdminSearch: Ha be van állítva 1, csak a rendszergazdai szerepkörrel rendelkező felhasználókat adja vissza. - A V18-ban bevezetett: – useridVesszővel tagolt értékeket (CSV) fogad el. ## Válasz törzsének frissítései – Új mezők hozzáadva: - emaildomain, , orginvitationsent, createdby, createddate, modifiedby,modifieddate - ifpartner , lastlogindate, invalidlogins,externalidpublicwebsiteprofileid - systemuser , resetpassworddate, , usertypeid,avatarpracticegroup - langcodepublicprofile , dateOfBirth ## Címformátum módosítása (a V11-ből) – A location címke át lett nevezve address konzisztenciaként. - Példaválasz: 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> ## Felhasználói szerepkörök (az API V11+-ban vezették be) – Példaválasz: 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> ## Korlátok és eltolások – Korlát viselkedése: - Alapértelmezett: 100 ha nincs megadva érték. - Az összes rekord visszaadására használható -1 . - Ha az érték kisebb, mint -1az alapértelmezett 100érték. - Eltolás viselkedése: – Alapértelmezett: 0 ha nincs megadva érték. - Ha az eltolás meghaladja az összes rekordot, az alapértelmezett érték vissza lesz kapcsolva.0 ## Új szerepkörök – V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Hibakódok | Összefoglalás | Ref Code (V4 előtt) | Ref Code (V4) | |---------|----------------------|--------------| | Érvénytelen bemenet a felhasználói állapothoz (AKTÍV, ARCHIVÁLT, INAKTÍV) | 147 | 147 | A szervezet azonosítója érvénytelen | N/A | 260 | | Érvénytelen neverinvited érték (igaz/hamis) | N/A | 387 | | Érvénytelen neverlogin érték (igaz/hamis) | N/A | 388 | | Érvénytelen groupids érték | N/A | 214 | | Érvénytelen notingroup érték (igaz/hamis) | N/A | 389 | | Érvénytelen ordertype (támogatott: név, szervezet, státusz stb.) | N/A | 289 | | Érvénytelen orderby (támogatott: asc, desc) | N/A | 290 | | Érvénytelen offset érték | 138 | 138 | | Érvénytelen limit érték | 137 | 137 | ## Megjegyzések – A V13-tól kezdődően ez az API minden felhasználó számára nyitva áll (korábban csak a rendszergazdák számára). – A V18-tól kezdődően a userregistered2FA mező azt jelzi, hogy egy felhasználó regisztrált-e 2FA-ra. --- Ez a leírás a Swagger 2.0 sémaformázást követi, és az Egyéni összekötő séma leírás mezőjébe kell helyezni.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

Az API verziója.
Felhasználó állapota
 status string

Felhasználók szűrése állapot szerint: Aktív, Archivált, Inaktív vagy Zárolt.
Lapozás eltolása
 offset string

Lapozás kezdőpozíciója.
Találatok korlátja
 limit string

Kérésenként visszaadandó elemek száma.
Szervezet azonosítója
 orgid string

Felhasználók szűrése szervezeti azonosító alapján.
Soha nem meghívott felhasználók
 neverinvited string

Kérje le azokat a felhasználókat, akiket még soha nem hívtak meg.
Soha nem bejelentkezett felhasználók
 neverlogin string

Kérje le azokat a felhasználókat, akik még nem jelentkeztek be.
Felhasználói azonosító
 userid string

Felhasználók szűrése egyedi felhasználói azonosító(ka)juk alapján.
Csoportazonosító
 groupid string

Felhasználók szűrése csoportazonosító(k) szerint.
Csoportokban nem szereplő felhasználók
 notingroup string

Kérje le azokat a felhasználókat, akik nem tartoznak egyik csoportba sem.
Rendezési sorrend típusa
 ordertype string

Felhasználók rendezése megadott mező, például név, szervezet vagy állapot szerint.
Rendezési sorrend
 orderby string

A rendezés eredménye növekvő vagy csökkenő sorrendben.
Külső ID
 externalid string

Felhasználók szűrése külső azonosító alapján.
Keresztnév
 firstname string

Felhasználók szűrése utónév alapján.
Vezetéknév
 lastname string

Felhasználók szűrése vezetéknév alapján.
E-mail cím
 email string

Felhasználók szűrése e-mail-cím alapján.
Felhasználói keresés
 search string

Felhasználók keresése különböző attribútumok, például név, e-mail és beosztás szerint.
Betűrendszűrő
 alphabets string

Szűrje azokat a felhasználókat, akiknek a vezetékneve egy adott betűvel kezdődik.
Beosztás
 jobtitle string

Felhasználók szűrése feladatcím szerint.
Elhelyezkedés
 locations string

Felhasználók szűrése városonként.
Department
 departments string

Felhasználók szűrése részlegek szerint.
Szervezet neve
 organisations string

Felhasználók szűrése szervezetnév alapján.
Specialitásokat
 specialities string

Felhasználók szűrése a szakterületeik alapján.
Rendszeradminisztrátori keresés
 systemAdminSearch string

Kérje le a rendszeradminisztrátori szerepkörrel rendelkező felhasználókat.

Válaszok

Törzs
users

Fájl feltöltése

Műveletazonosító:
insertDocument

Ez az API-hívás feltölt egy fájlt egy adott mappába a HighQ Együttműködési platformon. Támogatja az adattömbök feltöltését a Content-Range fejléc megadásakor.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

A használt API verzióját adja meg.
Feltöltendő fájl
 file True file

Megadja a feltöltendő fájlt.
Szülőmappa azonosítója
 parentfolderid True string

Megadja annak a szülőmappának az egyedi azonosítóját, amelyben a fájl fel lesz töltve.
Duplikált jelző felülbírálása
 overrideduplicate boolean

Azt jelzi, hogy felül kell-e bírálni az ismétlődő fájlfeltöltéseket.
Dokumentum neve
 filename True string

Megadja a dokumentum nevét.
Verzió megjegyzése
 versionnote string

A fájl verzióját leíró megjegyzést tartalmaz.
Progresszív műveleti kulcs
 progressiveoperkey string

Megadja a fájlfeltöltés során a progresszív műveletekhez használt kulcsot.
DMS-adatbázis neve
 dmsdatabasename string

A Dokumentumkezelő rendszer adatbázisának nevét adja meg.
DMS szerkesztési dátum
 dmseditdate string

A dokumentumkezelő rendszerben rögzített szerkesztési dátumot adja meg.
DMS szülőmappa azonosítója
 dmsparentfolderid string

Megadja a szülőmappa egyedi azonosítóját a dokumentumkezelő rendszerben.
DMS-dokumentum azonosítója
 dmsdocid string

Megadja a dokumentum egyedi azonosítóját a dokumentumkezelő rendszerben.
DMS-dokumentum verziója
 dmsversion string

A dokumentum dokumentumkezelő rendszerben rögzített verzióját adja meg.
Értesítés részletei
 notification string

A fájlfeltöltéskor küldendő értesítések részletei.
Batch-azonosító
 batchid string

Megadja a kötegművelet egyedi azonosítóját.
Gyökérmappa azonosítója
 rootfolderid string

Megadja a gyökérmappa egyedi azonosítóját.

Fájladatok lekérése

Műveletazonosító:
getDocumentInfo

Ez az API-hívás részletes információkat kér le egy adott fájlról a HighQ Együttműködési platformról.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

A használt API verzióját adja meg.
Fájlazonosító
 fileid True string

Megadja a fájl egyedi azonosítóját.
Legújabb DMS-információs jelző
 lastdmsinfo boolean

Azt jelzi, hogy lekéri-e a legújabb információkat a dokumentumkezelő rendszerből.
Mappatípus
 foldertype string

Megadja a mappa típusát, ha van ilyen.
Fájlállapot-adatok belefoglalása
 statusinfo boolean

Azt jelzi, hogy további fájlállapot-információkat, például megosztott állapotot, kedvenc állapotot, feladatszámot és kedvelt állapotot kíván-e tartalmazni. Az alapértelmezett érték hamis.
E-mail metaadatok belefoglalása
 emailmetadata boolean

Azt jelzi, hogy tartalmazzon-e e e-mail metaadatokat, például feladót, címzetteket és időbélyegeket. Az alapértelmezett érték hamis.

Válaszok

Törzs
DocumentDBO

ISheet-elemek listájának lekérése

Műveletazonosító:
getISheetItems

Ez az API-hívás lekéri a megadott iSheetben található elemek listáját.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

A használt API verzióját adja meg.
iSheet-azonosító
 isheetid True integer

Megadja az iSheet egyedi azonosítóját.
iSheet view ID
 sheetviewid integer

Megadja az iSheet nézet azonosítóját. Ha nincs megadva, a rendszer visszaadja az alapértelmezett nézetet.
Oszlopazonosító rendezése
 sortcolumnid integer

Az eredmények rendezéséhez használt oszlop azonosítóját adja meg.
Rendezési sorrend
 sortorder integer

Megadja a rendezési sorrendet. Használja például a 0 értéket növekvő sorrendben, vagy egy másik értéket csökkenő sorrendben.
Rekordkorlát
 limit integer

Megadja a visszaadni kívánt rekordok maximális számát; az alapértelmezett érték 100, ha nincs megadva.
Rekord eltolása
 offset integer

A rekordlekérés kezdőpozícióját adja meg; az alapértelmezett érték 0, ha nincs megadva.
Az összes oszlop belefoglalása
 allColumnRequired boolean

Egy jelölő, amely jelzi, hogy az összes oszlopadat szerepeljen-e az aktuális nézettől függetlenül.
Nézetkorlátozások figyelmen kívül hagyása
 isIgnoreView boolean

Egy jelző, amely azt jelzi, hogy figyelmen kívül kell-e hagyni a megtekintési korlátozásokat az elemadatok beolvasása során.

Válaszok

Name Elérési út Típus Description
adatlap
 isheet array of object

Az iSheet-elemek listája.
cikkszám
 isheet.itemId string

Az elem egyedi azonosítója.
adat
 isheet.data array of object

Az elem részletes adatai.
szekvencia
 isheet.data.sequence string

Az adatokhoz társított sorszám.
columnDisplayName
 isheet.data.columnDisplayName string

Az oszlop megjelenítendő neve.
value
 isheet.data.value string

Az oszlopban található érték.

iSheet-oszlopok lekérése

Műveletazonosító:
getIsheetColumns

Ez az API-hívás lekéri a megadott iSheethez társított oszlopokat. Ez a funkció az API 3- és újabb verziójában támogatott.

Paraméterek

Name Kulcs Kötelező Típus Description
iSheet-azonosító
 isheetid True integer

Megadja annak az iSheetnek az egyedi azonosítóját, amelyhez oszlopokra van szükség.
API-verzió
 version True string

A használt API verzióját adja meg.
iSheet view ID
 sheetviewid string

Megadja az iSheet nézet azonosítóját. Ha nincs megadva, a rendszer az összes oszlopot visszaadja.
Törölt iSheet-oszlopok belefoglalása
 onlyForDeletedIsheet boolean

Azt jelzi, hogy egy törölt iSheetből származó oszlopokat szeretne-e tartalmazni. Az alapértelmezett érték hamis.

Válaszok

Törzs
columns

Mappa létrehozása

Műveletazonosító:
addFolder

Ez az API létrehoz egy új mappát a megadott webhelyen belül. Lehetővé teszi a mappaadatok megadását, és biztosítja, hogy a mappa az adott szülőmappában legyen létrehozva.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

Az API-verziót adja meg.
Batch-azonosító
 batchid string

A kötegművelet egyedi azonosítója.
Gyökérmappa azonosítója
 rootfolderid string

A gyökérmappa egyedi azonosítója.
Szülőmappa azonosítója
 parentfolderid True string

Annak a szülőmappának az egyedi azonosítója, amelyben az új mappa létrejön.
Duplikált mappa engedélyezése
 allowduplicatefolder boolean

Azt jelzi, hogy engedélyezettek-e ismétlődő mappák a megadott szülőmappában.
név
 name True string

A mappa neve.
leírás
 description string

A mappa leírása.
accessInherited
 accessInherited integer

Azt jelzi, hogy a mappahozzáférés öröklődik-e.
batchID
 batchID string

A művelet kötegazonosítója.
dmsfolderid
 dmsfolderid string

A DMS-mappa azonosítója.
dmsParentFolderID
 dmsParentFolderID string

A DMS szülőmappájának azonosítója.
dmscreateddate
 dmscreateddate date-time

A DMS-mappa létrehozásának dátuma.
dmsmodifiedBy
 dmsmodifiedBy string

Az a felhasználó, aki legutóbb módosította a DMS mappát.
dmsdatabasename
 dmsdatabasename string

A DMS-adatbázis neve.
dmslink
 dmslink boolean

Azt jelzi, hogy elérhető-e DMS-hivatkozás.
dmslinkby
 dmslinkby string

A DMS mappát csatolt felhasználó.
e-mailmetadata
 emailmetadata string

A mappához társított metaadatok küldése e-mailben.

Válaszok

Törzs
FolderDBOV1

Mappaadatok lekérése

Műveletazonosító:
getFolderInfo

A metódus a megadott mappaazonosító mappaadatait tartalmazza.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

az API verziója
Mappaazonosító
 folderid True string

folderID
Állapotadatok
 statusinfo boolean

A statusinfo paraméter lehetővé teszi a mappa további információinak elérését. Az elérhető információk közé tartozik a megosztott állapot, a bejelentkezett felhasználó kedvenc állapota

Válaszok

Törzs
FolderDBOV2

Mappák listájának lekérése

Műveletazonosító:
getFolderList

Ez az API-hívás lekéri a megadott mappában található mappák listáját. A "korlát" paraméter beállítja a visszaadandó elemek maximális számát, az "eltolás" paraméter pedig az adatlekérés kiindulási helyét. Az alapértelmezett értékek akkor lesznek alkalmazva, ha ezek a paraméterek nincsenek megadva, és a rendszer növekvő sorrendben adja vissza a mappákat a létrehozás dátuma szerint.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

A használt API verzióját adja meg.
Mappaazonosító
 folderid True string

Megadja a mappa egyedi azonosítóját.
Elemek korlátja
 limit string

A visszaadni kívánt elemek maximális számát adja meg.
Elemek eltolása
 offset string

A visszaadott elemek kezdő pozícióját adja meg.
Rendezés iránya
 orderby string

Megadja az elemek rendezési irányát. A növekvő sorrendhez használja az "asc" vagy a "desc" értéket csökkenő sorrendben.
Rendezési feltétel
 ordertype string

Megadja az elemek (például név, szerző vagy utolsó módosítás dátuma) rendezésének feltételét.
Mappaállapot-adatok belefoglalása
 statusinfo boolean

Azt jelzi, hogy további mappaállapot-információkat is tartalmazzon-e. Az alapértelmezett érték hamis.
Intelligens mappák belefoglalása
 includesmartfolder boolean

Azt jelzi, hogy az intelligens mappák szerepeljenek-e a visszaadott listában. Az alapértelmezett érték hamis.

Válaszok

Name Elérési út Típus Description
mappa
 folder array of object
items
 folder object

Meglévő csoport hozzáadása a webhelyhez

Műveletazonosító:
addExistingGroupToSite

Ez az API-metódus hozzáad egy meglévő rendszercsoportot a webhelyhez.
Ezt az API-t kiterjesztették a meglévő rendszerszintű felhasználói csoportok (rendszer/szervezet típusú) hozzáadására a webhelyen.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

verzió
A webhely azonosítója
 siteid True string

A webhely azonosítója.
A rendszercsoport azonosítója
 groupid True string

A helyhez hozzáadni kívánt rendszercsoport azonosítója.

Válaszok

Törzs
sitegroup

Webhely frissítése

Műveletazonosító:
updateSite

Ezzel az API-végpontkal frissítheti egy meglévő webhely adatait. Az API ugyanazokat a mezőket támogatja, amelyeket a Webhely API létrehozásakor használnak.

Ez a módszer több anyagszámot is támogat, amelyek az API 10-es verziójával hozzáadhatóak a webhelyhez. A "matternos" címke több számsort jelöl, és olvashatóan vagy nem.

18-tól kezdődően: kategóriákra (webhelycélra) van szükség. Ha a webhely célja rejtett, megjelenik egy üzenet; ellenkező esetben a rejtett webhelycélok nem lesznek hozzáadva a webhelyhez.

A webhelytulajdonos mostantól más felhasználókhoz is hozzárendelhető, de a webhely résztvevőinek kell lenniük, és nagyobb szerepkörrel kell rendelkezniük, mint a webhelygazdák.

18-es verzió: a webhely tulajdonosa hozzáadhat más felhasználókat a webhelyhez.

Az API 19-es verziójától kezdve egy új, customPages nevű modult vezetünk be, amely szorosan kapcsolódik az otthoni modulhoz. Ha az otthoni modul értéke Igaz, a customPages értéknek igaznak kell lennie, és fordítva.

Vegye figyelembe, hogy a webhely válaszának lekérésében szereplő összes tulajdonság/elem nem frissíthető/beilleszthető. Az alábbi táblázatból megtudhatja, hogy mely írásvédett, frissíthető vagy beszúrható elemek olvashatók.

Paraméterek

Name Kulcs Kötelező Típus Description
A kért API verziója
 version True string

az API verziója
A webhely egyedi azonosítója
 siteid True string

A webhely azonosítója
azonosító
 id integer

A webhely azonosítója.
webhelynév
 sitename string

A webhely neve.
szerepkör
 role string

A webhely szerepe.
sitedescription
 sitedescription string

A webhely leírása.
enabledmodules
 enabledmodules string

A webhely számára engedélyezett modulok listája.
sitefolderID
 sitefolderID string

A webhely mappájának azonosítója.
sitefolderpermission
 sitefolderpermission string

A webhely mappájának engedélyszintje.
engedélyez
 enable string

A HomeDBO állapotának engedélyezése.
engedélyez
 enable string

Az ActivityDBO állapotának engedélyezése.
mikroblog
 microblog string

Az ActivityDBO-hoz társított mikroblog-tartalom.
docid
 docid string

Dokumentumazonosító.
blogTitle
 blogTitle string

A blogbejegyzés címe.
blogContent
 blogContent string

A blogbejegyzés tartalma.
showComment
 showComment integer

a megjegyzés megjelenítése.
címkék listája
 tagList array of string

A bloghoz társított címkék listája.
állapot
 status integer

a blogbejegyzés állapota.
siteID
 siteID integer

A társított webhely azonosítója.
szerző
 author string

A blog szerzője.
categoryList
 categoryList array of string

A blogbejegyzéshez rendelt kategóriák.
notificationTypeID
 notificationTypeID integer

Az értesítéstípus azonosítója.
üzenet
 message string

A bloghoz kapcsolódó üzenettartalmak.
messageCode
 messageCode integer

Az üzenethez társított kód.
külső azonosító
 externalID string

A bloghoz társított külső azonosító.
közzététel dátuma
 publishDate string

A blog közzétételi dátuma.
processtype
 processtype string

A bloghoz társított folyamattípus.
engedélyez
 enable string

A BlogDBO állapotának engedélyezése.
wikiid
 wikiid integer

A wiki egyedi azonosítója.
currentversionid
 currentversionid integer

A wiki aktuális verziójának azonosítója
parentwikiid
 parentwikiid integer

A szülő wiki azonosítója.
wikititle
 wikititle string

A wiki címe.
wikicontent
 wikicontent string

A wiki tartalma.
showcomment
 showcomment integer

Jelzi, hogy a megjegyzések engedélyezve vannak-e.
createddate
 createddate string

A wiki létrehozásának dátuma.
módosítottdátum
 modifieddate string

A wiki utolsó módosítási dátuma.
címkelista
 taglist string

A wikihöz társított címkék vesszővel tagolt listája.
wikipath
 wikipath string

A wiki elérésének elérési útja.
wikidraftid
 wikidraftid integer

A wiki piszkozatverziójának azonosítója.
piszkozattípus
 drafttype string

A wikihez társított vázlat típusa.
állapot
 status integer

A wiki aktuális állapota.
wikiversionid
 wikiversionid integer

A wiki verzióazonosítója.
index
 index string

A tevékenység indexe vagy azonosítója.
parenttaskid
 parenttaskid integer

A szülőfeladat azonosítója.
taskid
 taskid integer

A tevékenység egyedi azonosítója.
title
 title string

A feladat címe.
leírás
 description string

A tevékenység részletes leírása.
esedékesség
 duedate string

A tevékenység befejezésének határideje.
startdate
 startdate string

A tevékenység kezdeményezésének kezdő dátuma.
mattermaptaskid
 mattermaptaskid string

Azonosító, amely az anyagtérkép-feladathoz kapcsolódik.
típus
 type string

A tevékenység típusa vagy kategóriája.
dependon
 dependenton string

Tevékenységek, amelyektől ez a tevékenység függ.
daysfromdependent
 daysfromdependent string

A függő tevékenység napjainak száma.
ignoreweekend
 ignoreweekend integer

Azt jelzi, hogy a hétvégek figyelmen kívül vannak-e hagyva az ütemezésben.
duration
 duration integer

A tevékenység befejezésének időtartama.
erőforrás
 resource string

A tevékenységhez rendelt erőforrások.
eventTitle
 eventTitle string

Az esemény címe.
eventContent
 eventContent string

Az esemény tartalma.
showComment
 showComment integer

Jelzi, hogy engedélyezve vannak-e megjegyzések az eseményhez.
címkék listája
 tagList array of string

Az eseményhez társított címkék listája.
állapot
 status integer

Az esemény aktuális állapota.
siteID
 siteID integer

A webhely azonosítója.
kapcsolatfelvétel
 contact string

Az esemény kapcsolattartási adatai.
categoryList
 categoryList array of string

Kategóriák, amelyek alatt az esemény szerepel.
notificationTypeID
 notificationTypeID integer

Az eseményhez kapcsolódó értesítési típus.
üzenet
 message string

Az esemény üzenete.
messageCode
 messageCode integer

Az esemény üzenetkódja.
külső azonosító
 externalID string

A külső azonosító.
startDate
 startDate string

Az esemény kezdő dátuma.
befejezési dátum
 endDate string

Az esemény záró dátuma.
startTime
 startTime string

Az esemény kezdő időpontja.
endTime
 endTime string

Az esemény záró időpontja.
hely
 location string

Az esemény helye.
szerző
 author string

Az esemény szerzője.
processtype
 processtype string

Az esemény folyamatideje.
engedélyez
 enable string

Az Engedélyezés az esemény.
azonosító
 id integer

Az iSheet egyedi azonosítója.
title
 title string

Az iSheet címe.
leírás
 description string

Az adatlap leírása.
állapot
 status string

Az adatlap állapota.
accesstype
 accesstype string

Az adatlap hozzáférési típusa.
típus
 type string

Az adatlap típusa.
viewlink
 viewlink string

Hivatkozás az iSheet megtekintéséhez.
allowsections
 allowsections string

A szakaszok engedélyezettek-e.
allowlookup
 allowlookup string

Engedélyezve vannak-e a keresési mezők.
displayisheet
 displayisheet string

Az iSheet megjelenítési beállításai.
searchasdefaultview
 searchasdefaultview string

Azt jelzi, hogy a keresés alapértelmezett nézet-e.
enableversion
 enableversion string

Verziószámozást engedélyező jelző.
enablesheetalerter
 enablesheetalerter string

Jelölő a lapriasztások engedélyezéséhez.
alertercondition
 alertercondition string

Riasztások aktiválásának feltételei.
overrideitemmodifieddate
 overrideitemmodifieddate string

Felülbírálja a módosított dátumjelölőt.
enablebulkinsertupdate
 enablebulkinsertupdate string

Tömeges beszúrás/frissítés engedélyezése.
mezőleírók
 fielddescriptions string

Az iSheet mezőleírásai.
enablerowlocking
 enablerowlocking string

Sorszintű zárolás engedélyezése.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Többsoros szövegjelölő csonkálása.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

Többsoros csonkolás karakterkorlátja.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

A választható listaértékek újrafelhasználásának engedélyezése.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

A pontszámlista értékeinek újbóli felhasználásának engedélyezése.
allowIsheetComments
 allowIsheetComments string

Megjegyzések engedélyezése az iSheetben.
shareRecordsLimit
 shareRecordsLimit integer

A megosztható rekordok korlátja.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Engedélyezett rekordok megosztási korlátja.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Űrlapmegosztás engedélyezése rekordok hozzáadásához.
rekordszám
 recordcount string

Aktuális rekordszám.
sheettypeid
 sheettypeid integer

Az iSheet típusazonosítója
engedélyez
 enable string

A minőségbiztosítási funkciók engedélyezése.
userid
 userid integer

Felhasználói azonosító.
e-mail
 email string

e-mail-cím.
httpavatar
 httpavatar string

Az avatar HTTP URL-címe.
megtestesülés
 avatar string

Avatar kép.
userlink
 userlink string

Hivatkozás a felhasználói profilra.
httplink
 httplink string

HTTP-hivatkozás a felhasználói profilra.
phone
 phone string

Telefonszám.
mobil
 mobile string

Mobilszám.
osztály
 department string

A felhasználó részlege.
engedélyez
 enable string

A Contract Express integrációjának engedélyezése.
adminnote
 adminnote string

A webhelyhez kapcsolódó felügyeleti megjegyzések.
startdate
 startdate string

A webhely műveletének kezdő dátuma.
enddate
 enddate string

A webhely műveletének záró dátuma.
createddate
 createddate string

A webhely létrehozásának dátuma.
archivált dátum
 archiveddate string

A webhely archiválásának dátuma.
clientno
 clientno string

A webhelyhez társított ügyfélszám.
matterno
 matterno string

A webhelyhez társított szám.
kezdőlap
 landingpage string

A webhely kezdőlapjának URL-címe.
hivatkozás
 link string

A webhelyhez kapcsolódó hivatkozás.
állapot
 status string

A webhely aktuális állapota.
statusid
 statusid integer

A webhely állapotának azonosítója.
size
 size string

A webhely mérete.
billingnotes
 billingnotes string

A webhely számlázásával kapcsolatos megjegyzések.
billingnextinvoicedate
 billingnextinvoicedate string

A webhely következő számlájának dátuma.
billinglastinvoicedate
 billinglastinvoicedate string

A webhely utolsó számlájának dátuma.
filepagecount
 filepagecount string

A webhelyen található fájlok teljes lapszáma.
maxpagecount
 maxpagecount string

A webhelyen található fájlok maximálisan engedélyezett oldalszáma.
sitehttplink
 sitehttplink string

A webhely HTTP-hivatkozása.
isSyncable
 isSyncable integer

Azt jelzi, hogy a webhely szinkronizálható-e.
enforceusergroups
 enforceusergroups string

A webhelyhez kikényszerített felhasználói csoportok.
csvSiteCategory
 csvSiteCategory string

A webhely kategóriája CSV formátumban.
siteNameInDefaultLanguage
 siteNameInDefaultLanguage string

A webhely neve az alapértelmezett nyelven.
látható
 visible integer

Azt jelzi, hogy a webhely látható-e.
siteLogoName
 siteLogoName string

A webhely emblémájának neve.
siteLogoFileSize
 siteLogoFileSize integer

A webhely emblémájának fájlmérete.
siteLogoHeight
 siteLogoHeight integer

A webhely emblémájának magassága.
siteLogoWidth
 siteLogoWidth integer

A webhely emblémájának szélessége.
siteStatus
 siteStatus integer

A webhely állapotkódja.
applySiteTerms
 applySiteTerms integer

Azt jelzi, hogy a webhely feltételei érvényesek-e.
siteTerm
 siteTerm string

A webhelyre alkalmazott kifejezések.
termType
 termType integer

A webhelyre alkalmazott kifejezések típusa.
nextLoginSiteTerms
 nextLoginSiteTerms integer

Azt jelzi, hogy szükség van-e webhelyfeltételekre a következő bejelentkezéskor.
defaultSiteTermsEnable
 defaultSiteTermsEnable integer

Azt jelzi, hogy engedélyezve vannak-e az alapértelmezett helyfeltételek.
advancedQAPermission
 advancedQAPermission integer

A webhely speciális minőségbiztosítási engedélyszintje.
isBelső
 isInternal integer

Azt jelzi, hogy a webhely belső-e.
Psm
 psm integer

A Product Service Manager azonosítója.
siteLabelDisplay
 siteLabelDisplay string

A webhely megjelenítési címkéje.
allowSiteAdministration
 allowSiteAdministration integer

Jelzi, hogy engedélyezett-e a helyfelügyelet.
siteLevelPasswordEnable
 siteLevelPasswordEnable integer

A helyszintű jelszóvédelem engedélyezéséhez.
siteLevelPasscodeEnable
 siteLevelPasscodeEnable integer

Helyszintű pin-kódvédelem engedélyezése.
pin-kódUsingAuthApp
 passcodeUsingAuthApp integer

Azt jelzi, hogy a pin-kód hitelesítése használ-e hitelesítési alkalmazást.
sitePassword
 sitePassword string

A webhelyhez társított jelszó.
ipRestrictionEnable
 ipRestrictionEnable integer

Ip-korlátozások engedélyezése a webhely-hozzáféréshez.
availableIP
 availableIP string

A webhely eléréséhez engedélyezett IP-címek vesszővel tagolt listája.
highqDrive
 highqDrive integer

Azt jelzi, hogy engedélyezve van-e a HighQ Drive-integráció.
applySiteHomePage
 applySiteHomePage integer

Egyéni kezdőlap alkalmazása a webhelyre.
siteHomePage
 siteHomePage string

A webhely egyéni kezdőlapjának URL-címe.
siteHomePageType
 siteHomePageType integer

A kezdőlap típusa.
nextLoginSiteHomePage
 nextLoginSiteHomePage integer

A következő bejelentkezés beállítása a webhely kezdőlapjára.
applyDisplayContent
 applyDisplayContent integer

Megjelenítési tartalombeállítások alkalmazása.
displayContent
 displayContent string

A webhelyen megjelenítendő tartalom.
rssSecurity
 rssSecurity integer

RSS-hírcsatorna biztonsági szintje.
encryptedPassword
 encryptedPassword integer

Azt jelzi, hogy a webhely jelszava titkosítva van-e.
availableIPRangeCSV
 availableIPRangeCSV string

A webhely eléréséhez engedélyezett IP-címtartományok vesszővel tagolt listája.
siteModuleID
 siteModuleID integer

A helymodul azonosítója.
icalSecurity
 icalSecurity integer

iCal-adatcsatorna biztonsági szintje.
defaultDisplayContent
 defaultDisplayContent string

A webhelyen megjelenítendő alapértelmezett tartalom.
defaultEmailAlert
 defaultEmailAlert integer

Az alapértelmezett e-mail-riasztások engedélyezéséhez.
excelReportFooter
 excelReportFooter integer

Tartalmaz egy élőlábat az Excel-jelentésekben.
excelReportFooterText
 excelReportFooterText string

Az Excel-jelentések láblécében megjelenítendő szöveg.
announcementMLJSON
 announcementMLJSON string

JSON formátumú közlemények a webhelyhez.
sablon típusa
 templateType integer

A webhelyhez használt sablon típusa.
templateLicence
 templateLicence integer

A webhelysablon licenctípusa.
openChannelAppID
 openChannelAppID string

A nyílt csatorna integrációjának alkalmazásazonosítója.
itemid
 itemid integer

A webhelyhez társított elem azonosítója.
sitemetadatasheetid
 sitemetadatasheetid integer

A webhelyhez társított metaadatlap azonosítója.
mysite
 mysite boolean

Jelzi, hogy ez a felhasználó személyes webhelye-e.
lastaccesseddate
 lastaccesseddate string

A webhely legutóbbi elérésének dátuma és időpontja.
defaultViewerMetaDataTab
 defaultViewerMetaDataTab integer

A webhelymegjelenítő alapértelmezett metaadatainak lapja.
documentMetadataViewId
 documentMetadataViewId integer

dokumentum metaadatai a nézetazonosítóhoz.
folderMetadataViewId
 folderMetadataViewId integer

mappa metaadatai a nézetazonosítóhoz.
docSort
 docSort integer

A dokumentumok rendezési sorrendje.
folderSort
 folderSort integer

A mappák rendezési sorrendje.
defaultFolderRenderView
 defaultFolderRenderView integer

A mappák alapértelmezett nézetmódjának meghatározása.
isTaskAttachmentDefault
 isTaskAttachmentDefault integer

A feladatmellékletek alapértelmezett helye.
taskAttachmentDefaultFolderId
 taskAttachmentDefaultFolderId integer

A feladatmellékletek alapértelmezett helyeként kijelölt mappa egyedi azonosítója.
kedvenc
 favourite string

kedvenc állapota.
enabledocumentredaction
 enabledocumentredaction boolean

Megadja, hogy engedélyezve van-e a dokumentum-újrakifedés a webhelyen.
említéscsoportok
 mentiongroups integer

Az említett csoportok.
enablefilerelationships
 enablefilerelationships boolean

Azt jelzi, hogy engedélyezve vannak-e a fájlkapcsolatok.
filerelationshipsitepermissionlevel
 filerelationshipsitepermissionlevel integer

A fájlkapcsolatok kezeléséhez szükséges jogosultsági szint.

Webhely hozzáadása

Műveletazonosító:
createSite

Ezzel az API-val hozzon létre egy új webhelyet. A helyobjektum csak a létrehozási hely felületén látható attribútumokat támogatja.

Ehhez az API-hoz a helynév (és az ASP szintjén konfigurált kötelező mezők, ha vannak ilyenek) szükségesek egy új webhely létrehozásához.

A "modul" címke különböző, a webhelyen konfigurálni kívánt modult jelöl, ahogy az a kérelemattribútumokban is látható.
Webhely létrehozása sablonból a "sitetemplateid" címke megadásával
     - A 7-es verziónál kisebb verzió esetén, ha a kérelemben nincs megadva egy modul ("a modul" címke nem kerül átadásra), a sablonmodul konfigurálása megtörténik. Ha a modulcímke konfigurációval rendelkezik, az figyelembe veszi és a kérésben megadott módon konfigurálja (a sablonmodul konfigurációjának használata helyett)
     - A 7-es verziónál nagyobb verzió esetén, ha egy modult ("modul" címkét adnak át), vagy nem szerepel a kérelemben, a sablonmodul konfigurálása megtörténik.

Ez a módszer nem támogatja a webhelykép feltöltését ebben a hívásban, a webhelyikon támogatása külön hívásként lesz biztosítva.
A metódushívás egy meglévő kategóriaazonosítót vár. A kategóriaazonosítót a hívó alkalmazásnak a Webhelykategóriák felületére irányuló korábbi hívással kell beszereznie. Ha a kérelemben nincsenek kategóriák, a rendszer alapértelmezés szerint egyetlen kategóriát sem ad hozzá (tényleges kategória nélkül).

A webhely kezdő és záró dátumának "dd MMM yyyy" formátumban kell lennie, és NEM UTC. Az API-ügyfél mindig tényleges dátumot kér.

A "landingpage" alapértelmezett értéke "fájlok (gyökérmappa)".
A "landingpage" három különböző szövegre vagy azonosításra számít a Fájl modulhoz. A lehetséges értékek a következők:
- fájlok (gyökérmappa)
- fájlok (legutóbbi tevékenység)
- fájlok (speciális keresés)
A metódus implementációja mostantól támogatja (5.1-től) a többnyelvű helynevet. Az API 6-os vagy újabb <webhelyneve> a kérelem törzsében jelenik meg a felhasználói beállítások sorrendje alapján. Az API 5-ös vagy régebbi <webhelyneve> az alapértelmezett brit angol nyelvet fogja jelölni.
<A sitenametranslations> minden nyelven a webhelyneveket fogja jelölni (amely az "Object maga API" további címkéje lesz az 5.1-től kezdődően) API 6-os vagy újabb verziójában, a kérelem törzsében mindkét címkét küldik, például a helynevet< és >a sitenametranslationst<, >majd ellenőrizni kell az értékeket, például <a webhelynévnek> meg kell egyeznie a megfelelő <fordítási> címkével a felhasználó nyelvi beállításainak megfelelően. A sablonból létrehozott API 7-es vagy újabb verziója a forrássablonból származó modulokat követi, és figyelmen kívül hagyja a kérelem törzsében küldött modullistát.

A metódus implementációja mostantól támogatja a webhely sablonból való létrehozását a "sitetemplateid" címke megadásával (régi megközelítés)

Kérjük, vegye figyelembe, hogy a webhely sablonból való létrehozásának támogatása az API használatával a jövőben elavulttá válik. Ha sablonból szeretne webhelyet létrehozni, használja az új API Create site from template (/sites/templates/{templateid}/site) nevű webhelyet, amely egy hosszú lekérdezési API (amely támogatja a hosszú ideig futó kéréseket)

Ez a módszer több anyagszámot is támogat, amelyek az API 10-es verziójával hozzáadhatóak a webhelyhez. A "matternos" címke több számsort jelöl, és olvashatóan vagy nem. A régebbi (10-es verziónál kisebb) egyszámú "matterno" a helyszínen létező több anyagszám első anyagszámát fogja tükrözni.

18-tól kezdődően: kategóriákra (webhelycélra) van szükség. Ha a webhely célja rejtett, megjelenik egy üzenet; ellenkező esetben a rejtett webhelycélok nem lesznek hozzáadva a webhelyhez.

A 17-es verzióig: a webhely tulajdonosa a bejelentkezett felhasználó; más felhasználók nem vehetők fel.

18-es verzió: a webhely tulajdonosa hozzáadhat más felhasználókat a webhelyhez.

Az API 19-es verziójától kezdve egy új modult vezetnek be "customPages" néven, amely szorosan kapcsolódik az otthoni modulhoz. Tehát ha az otthoni modul értéke Igaz, a customPages értéke igaz lesz, és fordítva.

Paraméterek

Name Kulcs Kötelező Típus Description
A kért API verziója
 version True string

az API verziója
azonosító
 id integer

A webhely azonosítója.
webhelynév
 sitename string

A webhely neve.
szerepkör
 role string

A webhely szerepe.
sitedescription
 sitedescription string

A webhely leírása.
enabledmodules
 enabledmodules string

A webhely számára engedélyezett modulok listája.
sitefolderID
 sitefolderID string

A webhely mappájának azonosítója.
sitefolderpermission
 sitefolderpermission string

A webhely mappájának engedélyszintje.
engedélyez
 enable string

A HomeDBO állapotának engedélyezése.
engedélyez
 enable string

Az ActivityDBO állapotának engedélyezése.
mikroblog
 microblog string

Az ActivityDBO-hoz társított mikroblog-tartalom.
docid
 docid string

Dokumentumazonosító.
blogTitle
 blogTitle string

A blogbejegyzés címe.
blogContent
 blogContent string

A blogbejegyzés tartalma.
showComment
 showComment integer

a megjegyzés megjelenítése.
címkék listája
 tagList array of string

A bloghoz társított címkék listája.
állapot
 status integer

a blogbejegyzés állapota.
siteID
 siteID integer

A társított webhely azonosítója.
szerző
 author string

A blog szerzője.
categoryList
 categoryList array of string

A blogbejegyzéshez rendelt kategóriák.
notificationTypeID
 notificationTypeID integer

Az értesítéstípus azonosítója.
üzenet
 message string

A bloghoz kapcsolódó üzenettartalmak.
messageCode
 messageCode integer

Az üzenethez társított kód.
külső azonosító
 externalID string

A bloghoz társított külső azonosító.
közzététel dátuma
 publishDate string

A blog közzétételi dátuma.
processtype
 processtype string

A bloghoz társított folyamattípus.
engedélyez
 enable string

A BlogDBO állapotának engedélyezése.
wikiid
 wikiid integer

A wiki egyedi azonosítója.
currentversionid
 currentversionid integer

A wiki aktuális verziójának azonosítója
parentwikiid
 parentwikiid integer

A szülő wiki azonosítója.
wikititle
 wikititle string

A wiki címe.
wikicontent
 wikicontent string

A wiki tartalma.
showcomment
 showcomment integer

Jelzi, hogy a megjegyzések engedélyezve vannak-e.
createddate
 createddate string

A wiki létrehozásának dátuma.
módosítottdátum
 modifieddate string

A wiki utolsó módosítási dátuma.
címkelista
 taglist string

A wikihöz társított címkék vesszővel tagolt listája.
wikipath
 wikipath string

A wiki elérésének elérési útja.
wikidraftid
 wikidraftid integer

A wiki piszkozatverziójának azonosítója.
piszkozattípus
 drafttype string

A wikihez társított vázlat típusa.
állapot
 status integer

A wiki aktuális állapota.
wikiversionid
 wikiversionid integer

A wiki verzióazonosítója.
index
 index string

A tevékenység indexe vagy azonosítója.
parenttaskid
 parenttaskid integer

A szülőfeladat azonosítója.
taskid
 taskid integer

A tevékenység egyedi azonosítója.
title
 title string

A feladat címe.
leírás
 description string

A tevékenység részletes leírása.
esedékesség
 duedate string

A tevékenység befejezésének határideje.
startdate
 startdate string

A tevékenység kezdeményezésének kezdő dátuma.
mattermaptaskid
 mattermaptaskid string

Azonosító, amely az anyagtérkép-feladathoz kapcsolódik.
típus
 type string

A tevékenység típusa vagy kategóriája.
dependon
 dependenton string

Tevékenységek, amelyektől ez a tevékenység függ.
daysfromdependent
 daysfromdependent string

A függő tevékenység napjainak száma.
ignoreweekend
 ignoreweekend integer

Azt jelzi, hogy a hétvégek figyelmen kívül vannak-e hagyva az ütemezésben.
duration
 duration integer

A tevékenység befejezésének időtartama.
erőforrás
 resource string

A tevékenységhez rendelt erőforrások.
eventTitle
 eventTitle string

Az esemény címe.
eventContent
 eventContent string

Az esemény tartalma.
showComment
 showComment integer

Jelzi, hogy engedélyezve vannak-e megjegyzések az eseményhez.
címkék listája
 tagList array of string

Az eseményhez társított címkék listája.
állapot
 status integer

Az esemény aktuális állapota.
siteID
 siteID integer

A webhely azonosítója.
kapcsolatfelvétel
 contact string

Az esemény kapcsolattartási adatai.
categoryList
 categoryList array of string

Kategóriák, amelyek alatt az esemény szerepel.
notificationTypeID
 notificationTypeID integer

Az eseményhez kapcsolódó értesítési típus.
üzenet
 message string

Az esemény üzenete.
messageCode
 messageCode integer

Az esemény üzenetkódja.
külső azonosító
 externalID string

A külső azonosító.
startDate
 startDate string

Az esemény kezdő dátuma.
befejezési dátum
 endDate string

Az esemény záró dátuma.
startTime
 startTime string

Az esemény kezdő időpontja.
endTime
 endTime string

Az esemény záró időpontja.
hely
 location string

Az esemény helye.
szerző
 author string

Az esemény szerzője.
processtype
 processtype string

Az esemény folyamatideje.
engedélyez
 enable string

Az Engedélyezés az esemény.
azonosító
 id integer

Az iSheet egyedi azonosítója.
title
 title string

Az iSheet címe.
leírás
 description string

Az adatlap leírása.
állapot
 status string

Az adatlap állapota.
accesstype
 accesstype string

Az adatlap hozzáférési típusa.
típus
 type string

Az adatlap típusa.
viewlink
 viewlink string

Hivatkozás az iSheet megtekintéséhez.
allowsections
 allowsections string

A szakaszok engedélyezettek-e.
allowlookup
 allowlookup string

Engedélyezve vannak-e a keresési mezők.
displayisheet
 displayisheet string

Az iSheet megjelenítési beállításai.
searchasdefaultview
 searchasdefaultview string

Azt jelzi, hogy a keresés alapértelmezett nézet-e.
enableversion
 enableversion string

Verziószámozást engedélyező jelző.
enablesheetalerter
 enablesheetalerter string

Jelölő a lapriasztások engedélyezéséhez.
alertercondition
 alertercondition string

Riasztások aktiválásának feltételei.
overrideitemmodifieddate
 overrideitemmodifieddate string

Felülbírálja a módosított dátumjelölőt.
enablebulkinsertupdate
 enablebulkinsertupdate string

Tömeges beszúrás/frissítés engedélyezése.
mezőleírók
 fielddescriptions string

Az iSheet mezőleírásai.
enablerowlocking
 enablerowlocking string

Sorszintű zárolás engedélyezése.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Többsoros szövegjelölő csonkálása.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

Többsoros csonkolás karakterkorlátja.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

A választható listaértékek újrafelhasználásának engedélyezése.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

A pontszámlista értékeinek újbóli felhasználásának engedélyezése.
allowIsheetComments
 allowIsheetComments string

Megjegyzések engedélyezése az iSheetben.
shareRecordsLimit
 shareRecordsLimit integer

A megosztható rekordok korlátja.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Engedélyezett rekordok megosztási korlátja.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Űrlapmegosztás engedélyezése rekordok hozzáadásához.
rekordszám
 recordcount string

Aktuális rekordszám.
sheettypeid
 sheettypeid integer

Az iSheet típusazonosítója
engedélyez
 enable string

A minőségbiztosítási funkciók engedélyezése.
userid
 userid integer

Felhasználói azonosító.
e-mail
 email string

e-mail-cím.
httpavatar
 httpavatar string

Az avatar HTTP URL-címe.
megtestesülés
 avatar string

Avatar kép.
userlink
 userlink string

Hivatkozás a felhasználói profilra.
httplink
 httplink string

HTTP-hivatkozás a felhasználói profilra.
phone
 phone string

Telefonszám.
mobil
 mobile string

Mobilszám.
osztály
 department string

A felhasználó részlege.
engedélyez
 enable string

A Contract Express integrációjának engedélyezése.
adminnote
 adminnote string

A webhelyhez kapcsolódó felügyeleti megjegyzések.
startdate
 startdate string

A webhely műveletének kezdő dátuma.
enddate
 enddate string

A webhely műveletének záró dátuma.
createddate
 createddate string

A webhely létrehozásának dátuma.
archivált dátum
 archiveddate string

A webhely archiválásának dátuma.
clientno
 clientno string

A webhelyhez társított ügyfélszám.
matterno
 matterno string

A webhelyhez társított szám.
kezdőlap
 landingpage string

A webhely kezdőlapjának URL-címe.
hivatkozás
 link string

A webhelyhez kapcsolódó hivatkozás.
állapot
 status string

A webhely aktuális állapota.
statusid
 statusid integer

A webhely állapotának azonosítója.
size
 size string

A webhely mérete.
billingnotes
 billingnotes string

A webhely számlázásával kapcsolatos megjegyzések.
billingnextinvoicedate
 billingnextinvoicedate string

A webhely következő számlájának dátuma.
billinglastinvoicedate
 billinglastinvoicedate string

A webhely utolsó számlájának dátuma.
filepagecount
 filepagecount string

A webhelyen található fájlok teljes lapszáma.
maxpagecount
 maxpagecount string

A webhelyen található fájlok maximálisan engedélyezett oldalszáma.
sitehttplink
 sitehttplink string

A webhely HTTP-hivatkozása.
isSyncable
 isSyncable integer

Azt jelzi, hogy a webhely szinkronizálható-e.
enforceusergroups
 enforceusergroups string

A webhelyhez kikényszerített felhasználói csoportok.
csvSiteCategory
 csvSiteCategory string

A webhely kategóriája CSV formátumban.
siteNameInDefaultLanguage
 siteNameInDefaultLanguage string

A webhely neve az alapértelmezett nyelven.
látható
 visible integer

Azt jelzi, hogy a webhely látható-e.
siteLogoName
 siteLogoName string

A webhely emblémájának neve.
siteLogoFileSize
 siteLogoFileSize integer

A webhely emblémájának fájlmérete.
siteLogoHeight
 siteLogoHeight integer

A webhely emblémájának magassága.
siteLogoWidth
 siteLogoWidth integer

A webhely emblémájának szélessége.
siteStatus
 siteStatus integer

A webhely állapotkódja.
applySiteTerms
 applySiteTerms integer

Azt jelzi, hogy a webhely feltételei érvényesek-e.
siteTerm
 siteTerm string

A webhelyre alkalmazott kifejezések.
termType
 termType integer

A webhelyre alkalmazott kifejezések típusa.
nextLoginSiteTerms
 nextLoginSiteTerms integer

Azt jelzi, hogy szükség van-e webhelyfeltételekre a következő bejelentkezéskor.
defaultSiteTermsEnable
 defaultSiteTermsEnable integer

Azt jelzi, hogy engedélyezve vannak-e az alapértelmezett helyfeltételek.
advancedQAPermission
 advancedQAPermission integer

A webhely speciális minőségbiztosítási engedélyszintje.
isBelső
 isInternal integer

Azt jelzi, hogy a webhely belső-e.
Psm
 psm integer

A Product Service Manager azonosítója.
siteLabelDisplay
 siteLabelDisplay string

A webhely megjelenítési címkéje.
allowSiteAdministration
 allowSiteAdministration integer

Jelzi, hogy engedélyezett-e a helyfelügyelet.
siteLevelPasswordEnable
 siteLevelPasswordEnable integer

A helyszintű jelszóvédelem engedélyezéséhez.
siteLevelPasscodeEnable
 siteLevelPasscodeEnable integer

Helyszintű pin-kódvédelem engedélyezése.
pin-kódUsingAuthApp
 passcodeUsingAuthApp integer

Azt jelzi, hogy a pin-kód hitelesítése használ-e hitelesítési alkalmazást.
sitePassword
 sitePassword string

A webhelyhez társított jelszó.
ipRestrictionEnable
 ipRestrictionEnable integer

Ip-korlátozások engedélyezése a webhely-hozzáféréshez.
availableIP
 availableIP string

A webhely eléréséhez engedélyezett IP-címek vesszővel tagolt listája.
highqDrive
 highqDrive integer

Azt jelzi, hogy engedélyezve van-e a HighQ Drive-integráció.
applySiteHomePage
 applySiteHomePage integer

Egyéni kezdőlap alkalmazása a webhelyre.
siteHomePage
 siteHomePage string

A webhely egyéni kezdőlapjának URL-címe.
siteHomePageType
 siteHomePageType integer

A kezdőlap típusa.
nextLoginSiteHomePage
 nextLoginSiteHomePage integer

A következő bejelentkezés beállítása a webhely kezdőlapjára.
applyDisplayContent
 applyDisplayContent integer

Megjelenítési tartalombeállítások alkalmazása.
displayContent
 displayContent string

A webhelyen megjelenítendő tartalom.
rssSecurity
 rssSecurity integer

RSS-hírcsatorna biztonsági szintje.
encryptedPassword
 encryptedPassword integer

Azt jelzi, hogy a webhely jelszava titkosítva van-e.
availableIPRangeCSV
 availableIPRangeCSV string

A webhely eléréséhez engedélyezett IP-címtartományok vesszővel tagolt listája.
siteModuleID
 siteModuleID integer

A helymodul azonosítója.
icalSecurity
 icalSecurity integer

iCal-adatcsatorna biztonsági szintje.
defaultDisplayContent
 defaultDisplayContent string

A webhelyen megjelenítendő alapértelmezett tartalom.
defaultEmailAlert
 defaultEmailAlert integer

Az alapértelmezett e-mail-riasztások engedélyezéséhez.
excelReportFooter
 excelReportFooter integer

Tartalmaz egy élőlábat az Excel-jelentésekben.
excelReportFooterText
 excelReportFooterText string

Az Excel-jelentések láblécében megjelenítendő szöveg.
announcementMLJSON
 announcementMLJSON string

JSON formátumú közlemények a webhelyhez.
sablon típusa
 templateType integer

A webhelyhez használt sablon típusa.
templateLicence
 templateLicence integer

A webhelysablon licenctípusa.
openChannelAppID
 openChannelAppID string

A nyílt csatorna integrációjának alkalmazásazonosítója.
itemid
 itemid integer

A webhelyhez társított elem azonosítója.
sitemetadatasheetid
 sitemetadatasheetid integer

A webhelyhez társított metaadatlap azonosítója.
mysite
 mysite boolean

Jelzi, hogy ez a felhasználó személyes webhelye-e.
lastaccesseddate
 lastaccesseddate string

A webhely legutóbbi elérésének dátuma és időpontja.
defaultViewerMetaDataTab
 defaultViewerMetaDataTab integer

A webhelymegjelenítő alapértelmezett metaadatainak lapja.
documentMetadataViewId
 documentMetadataViewId integer

dokumentum metaadatai a nézetazonosítóhoz.
folderMetadataViewId
 folderMetadataViewId integer

mappa metaadatai a nézetazonosítóhoz.
docSort
 docSort integer

A dokumentumok rendezési sorrendje.
folderSort
 folderSort integer

A mappák rendezési sorrendje.
defaultFolderRenderView
 defaultFolderRenderView integer

A mappák alapértelmezett nézetmódjának meghatározása.
isTaskAttachmentDefault
 isTaskAttachmentDefault integer

A feladatmellékletek alapértelmezett helye.
taskAttachmentDefaultFolderId
 taskAttachmentDefaultFolderId integer

A feladatmellékletek alapértelmezett helyeként kijelölt mappa egyedi azonosítója.
kedvenc
 favourite string

kedvenc állapota.
enabledocumentredaction
 enabledocumentredaction boolean

Megadja, hogy engedélyezve van-e a dokumentum-újrakifedés a webhelyen.
említéscsoportok
 mentiongroups integer

Az említett csoportok.
enablefilerelationships
 enablefilerelationships boolean

Azt jelzi, hogy engedélyezve vannak-e a fájlkapcsolatok.
filerelationshipsitepermissionlevel
 filerelationshipsitepermissionlevel integer

A fájlkapcsolatok kezeléséhez szükséges jogosultsági szint.

Válaszok

Törzs
site

Webhelycsoport frissítése

Műveletazonosító:
updateSiteGroup

Ez az API-metódus frissíti a webhely egy meglévő csoportjának nevét.
Ezt az API-t kiterjesztették a webhely meglévő alapszintű felhasználói csoportjának nevének frissítésére.

Paraméterek

Name Kulcs Kötelező Típus Description
API-verzió
 version True string

verzió
A webhely azonosítója
 siteid True string

A webhely azonosítója.
API-verzió
 groupid True string 
The ID of the site group.
név
 name string
azonosító
 id integer
copypermissionsfrom
 copypermissionsfrom string
üzenet
 message string
typeID
 typeID integer
típus
 type string
numberofusers
 numberofusers string
Létrehozott
 created string
modified
 modified string
systemGroupID
 systemGroupID integer
leírás
 description string
basicusergroup
 basicusergroup integer

Válaszok

Törzs
sitegroup

Definíciók

ErrorDBO

Name Elérési út Típus Description
összegzés
 summary string
Ref
 ref string
hivatkozás
 link string

DocumentDBO

Name Elérési út Típus Description
docid
 docid string

Dokumentumazonosító.

columns

Name Elérési út Típus Description
oszlop
 column array of object
items
 column object

LocationDBO

Name Elérési út Típus Description
címsor1
 addressline1 string

A cím első sora.
címvonal2
 addressline2 string

A cím második sora.
addressline3
 addressline3 string

A cím harmadik sora.
city
 city string

A cím városa.
state
 state string

A cím állapota.
country
 country string

A cím országa.
irányítószám
 postcode string

A cím irányítószáma.

UserName

Name Elérési út Típus Description
title
 title string

A felhasználó címe.
keresztnév
 firstname string

A felhasználó utóneve.
vezetéknév
 lastname string

A felhasználó vezetékneve.
goesby
 goesby string

a felhasználó preferált neve.

MetadataListDBO

Name Elérési út Típus Description
metaadatnév
 metadataname array of string
metaadatérték
 metadatavalue array of string
Name Elérési út Típus Description
azonosító
 id string

Hivatkozás azonosítója
név
 name string

Hivatkozás neve.
value
 value string

Hivatkozás értéke.
Name Elérési út Típus Description
hivatkozás
 link array of NameValueLink

ExperiencesDBO

Name Elérési út Típus Description
élmény
 experience array of string

GroupsDBO

Name Elérési út Típus Description
csoport
 group array of string

felhasználó

Name Elérési út Típus Description
userid
 userid integer

Felhasználói azonosító.
alábbi
 following boolean

Alábbi.
e-mail
 email string

E-mail-cím.
név
 name UserName
userlink
 userlink string

Felhasználói hivatkozás.
httplink
 httplink string

HTTP-hivatkozás.
httpavatar
 httpavatar string

HTTP Avatar.
megtestesülés
 avatar integer

A felhasználó avatarja.
externalid
 externalid string

Külső azonosító.
dateofbirth
 dateofbirth string

Születési dátum.
phone
 phone string

Telefonszám.
jobtitle
 jobtitle string

Feladat címe.
mobil
 mobile string

Mobilszám.
osztály
 department string

Deparment.
állapot
 status string

Állapot.
szervezet
 org string

Szervezet.
orgName
 orgName string

Szervezet neve.
hely
 location LocationDBO
img
 img string

Kép.
Tapasztalatok
 experiences ExperiencesDBO
sociallinks
 sociallinks Link
egyéni hivatkozás
 customlink Link
messaginglink
 messaginglink Link
secretaryname
 secretaryname string

Titkár neve.
secretarymail
 secretarymail string

Mail titkárnő.
bio
 bio string

A felhasználó életrajza.
sourcetype
 sourcetype string

Forrás típusa.
Specialitásokat
 specialities string

Specialitásokat.
reportsto
 reportsto string

Az aktuális felhasználói jelentés felhasználója.
metaadat
 metadata MetadataListDBO
groups
 groups GroupsDBO
toldalék
 suffix string

A felhasználó nevének utótagja.
atomlink
 atomlink string

A felhasználóhoz társított atomhivatkozás.
hivatkozás
 link string

A felhasználóhoz társított hivatkozás.
loggeduserlike
 loggeduserlike integer

A bejelentkezett felhasználó által kapott kedvelések száma.
Felhasználónév
 userName string

Felhasználónév.

users

Name Elérési út Típus Description
felhasználó
 user array of user

FolderDBOV1

Name Elérési út Típus Description
mappaazonosító
 folderid string

A létrehozott mappa egyedi azonosítója.

DmsDBO

Name Elérési út Típus Description
dmsfolderid
 dmsfolderid string

A DMS-mappa azonosítója.
dmsParentFolderID
 dmsParentFolderID string

A DMS szülőmappájának azonosítója.
dmscreateddate
 dmscreateddate date-time

A DMS-mappa létrehozásának dátuma.
dmsmodifiedBy
 dmsmodifiedBy string

Az a felhasználó, aki legutóbb módosította a DMS mappát.
dmsdatabasename
 dmsdatabasename string

A DMS-adatbázis neve.
dmslink
 dmslink boolean

Azt jelzi, hogy elérhető-e DMS-hivatkozás.
dmslinkby
 dmslinkby string

A DMS mappát csatolt felhasználó.

sitegroup

Name Elérési út Típus Description
név
 name string
azonosító
 id integer
copypermissionsfrom
 copypermissionsfrom string
üzenet
 message string
typeID
 typeID integer
típus
 type string
numberofusers
 numberofusers string
Létrehozott
 created string
modified
 modified string
systemGroupID
 systemGroupID integer
leírás
 description string
basicusergroup
 basicusergroup integer

Address

Name Elérési út Típus Description
addressid
 addressid string

A cím egyedi azonosítója.
címsor1
 addressline1 string

A cím első sora.
címvonal2
 addressline2 string

A cím második sora.
addressline3
 addressline3 string

A cím harmadik sora.
city
 city string

A cím városa.
state
 state string

A cím állapota.
country
 country string

A cím országa.
irányítószám
 postCode string

A cím irányítószáma.
ismertek
 knownas string

A cím alternatív neve vagy beceneve.

IntegrationUserDBO

Name Elérési út Típus Description
index
 index integer

A felhasználó egyedi indexe.
userid
 userid integer

A felhasználó egyedi azonosítója.
keresztnév
 firstname string

A felhasználó utóneve.
vezetéknév
 lastname string

A felhasználó vezetékneve.
practicegroup
 practicegroup string

Gyakorlatcsoport, amelyhez a felhasználó tartozik.
langcode
 langcode string

A felhasználó nyelvkódja.
localeID
 localeID string

A felhasználó területi azonosítója.
publicprofile
 publicprofile string

A felhasználó nyilvános profilja.
pwpid
 pwpid string

A felhasználó PWP-azonosítója.
usertypeid
 usertypeid string

Felhasználótípus azonosítója.
rendszerfelhasználó
 systemuser string

Rendszerfelhasználói jelző.
e-mail
 email string

Email felhasználó címe.
phone
 phone string

A felhasználó telefonszáma.
mobil
 mobile string

A felhasználó mobilszáma.
osztály
 department string

A felhasználó részlege.
szervezet
 org string

Szervezet, amelyhez a felhasználó tartozik.
hely
 location LocationDBO
address
 address Address
Tapasztalatok
 experiences ExperiencesDBO
sociallinks
 sociallinks Link
messaginglink
 messaginglink Link
egyéni hivatkozás
 customlink Link
img
 img string
reportsto
 reportsto string
metaadat
 metadata MetadataListDBO
groups
 groups GroupsDBO
externalid
 externalid string

A felhasználó külső azonosítója.
jobtitle
 jobtitle string

A felhasználó beosztása.
secretaryname
 secretaryname string

A felhasználó titkárának neve.
secretarymail
 secretarymail string

A felhasználó titkárának e-mail-címe.
Specialitásokat
 specialities string

A felhasználó különlegességei.
title
 title string

A felhasználó címe.
goesby
 goesby string

a felhasználó preferált neve.
toldalék
 suffix string

A felhasználó nevének utótagja.
atomlink
 atomlink string

A felhasználóhoz társított atomhivatkozás.
bio
 bio string

A felhasználó életrajza.
dateOfBirth
 dateOfBirth string

A felhasználó születési dátuma.
hivatkozás
 link string

A felhasználóhoz társított hivatkozás.
állapot
 status string

A felhasználó állapota.
állapotkód
 statuscode string

A felhasználó állapotkódja.
üzenet
 message string

A felhasználóhoz társított üzenet.
sourcetype
 sourcetype string

A felhasználó forrástípusa.
orgid
 orgid string

Szervezeti azonosító.
ifpartner
 ifpartner string

Partnerjelölő.
e-mail-cím
 emaildomain string

A felhasználó e-mail-tartománya.
invitationsent
 invitationsent string

Meghívó elküldve jelző.
létrehozta
 createdby string

A rekordot létrehozó felhasználó.
createddate
 createddate string

A rekord létrehozásának dátuma.
módosítva
 modifiedby string

A rekordot módosító felhasználó.
módosítottdátum
 modifieddate string

A rekord módosításának dátuma.
lastlogindate
 lastlogindate string

Az utolsó bejelentkezés dátuma.
invalidlogins
 invalidlogins string

Érvénytelen bejelentkezési kísérletek száma.
publicwebsiteprofileid
 publicwebsiteprofileid string

Nyilvános webhelyprofil azonosítója.
resetpassworddate
 resetpassworddate string

A jelszó alaphelyzetbe állításának dátuma.
megtestesülés
 avatar string

Avatar kép URL-címe.
followingcount
 followingcount integer

Követett felhasználók száma.
followercount
 followercount integer

Követők száma.
alábbi
 following boolean

Következő jelölő.
szerepkör
 role string

A felhasználó szerepköre.
isbasicuser
 isbasicuser string

Egyszerű felhasználói jelző.
encryptedUserId
 encryptedUserId string

Titkosított felhasználói azonosító.
önregisztrált
 selfregistered integer

Ön által regisztrált jelző.
registeredWith2FA
 registeredWith2FA string

Kéttényezős hitelesítés regisztrációs jelzője.
isBelső
 isInternal integer

Belső felhasználói jelző.
orgName
 orgName string

A szervezet neve.

hely

Name Elérési út Típus Description
azonosító
 id integer

A webhely azonosítója.
webhelynév
 sitename string

A webhely neve.
szerepkör
 role string

A webhely szerepe.
sitedescription
 sitedescription string

A webhely leírása.
enabledmodules
 enabledmodules string

A webhely számára engedélyezett modulok listája.
sitefolderID
 sitefolderID string

A webhely mappájának azonosítója.
sitefolderpermission
 sitefolderpermission string

A webhely mappájának engedélyszintje.
modul
 module ModuleDBO
adminnote
 adminnote string

A webhelyhez kapcsolódó felügyeleti megjegyzések.
startdate
 startdate string

A webhely műveletének kezdő dátuma.
enddate
 enddate string

A webhely műveletének záró dátuma.
createddate
 createddate string

A webhely létrehozásának dátuma.
archivált dátum
 archiveddate string

A webhely archiválásának dátuma.
clientno
 clientno string

A webhelyhez társított ügyfélszám.
matterno
 matterno string

A webhelyhez társított szám.
kezdőlap
 landingpage string

A webhely kezdőlapjának URL-címe.
hivatkozás
 link string

A webhelyhez kapcsolódó hivatkozás.
állapot
 status string

A webhely aktuális állapota.
statusid
 statusid integer

A webhely állapotának azonosítója.
size
 size string

A webhely mérete.
billingnotes
 billingnotes string

A webhely számlázásával kapcsolatos megjegyzések.
billingnextinvoicedate
 billingnextinvoicedate string

A webhely következő számlájának dátuma.
billinglastinvoicedate
 billinglastinvoicedate string

A webhely utolsó számlájának dátuma.
filepagecount
 filepagecount string

A webhelyen található fájlok teljes lapszáma.
maxpagecount
 maxpagecount string

A webhelyen található fájlok maximálisan engedélyezett oldalszáma.
sitehttplink
 sitehttplink string

A webhely HTTP-hivatkozása.
isSyncable
 isSyncable integer

Azt jelzi, hogy a webhely szinkronizálható-e.
enforceusergroups
 enforceusergroups string

A webhelyhez kikényszerített felhasználói csoportok.
csvSiteCategory
 csvSiteCategory string

A webhely kategóriája CSV formátumban.
siteNameInDefaultLanguage
 siteNameInDefaultLanguage string

A webhely neve az alapértelmezett nyelven.
látható
 visible integer

Azt jelzi, hogy a webhely látható-e.
siteLogoName
 siteLogoName string

A webhely emblémájának neve.
siteLogoFileSize
 siteLogoFileSize integer

A webhely emblémájának fájlmérete.
siteLogoHeight
 siteLogoHeight integer

A webhely emblémájának magassága.
siteLogoWidth
 siteLogoWidth integer

A webhely emblémájának szélessége.
siteStatus
 siteStatus integer

A webhely állapotkódja.
applySiteTerms
 applySiteTerms integer

Azt jelzi, hogy a webhely feltételei érvényesek-e.
siteTerm
 siteTerm string

A webhelyre alkalmazott kifejezések.
termType
 termType integer

A webhelyre alkalmazott kifejezések típusa.
nextLoginSiteTerms
 nextLoginSiteTerms integer

Azt jelzi, hogy szükség van-e webhelyfeltételekre a következő bejelentkezéskor.
defaultSiteTermsEnable
 defaultSiteTermsEnable integer

Azt jelzi, hogy engedélyezve vannak-e az alapértelmezett helyfeltételek.
advancedQAPermission
 advancedQAPermission integer

A webhely speciális minőségbiztosítási engedélyszintje.
isBelső
 isInternal integer

Azt jelzi, hogy a webhely belső-e.
Psm
 psm integer

A Product Service Manager azonosítója.
siteLabelDisplay
 siteLabelDisplay string

A webhely megjelenítési címkéje.
allowSiteAdministration
 allowSiteAdministration integer

Jelzi, hogy engedélyezett-e a helyfelügyelet.
siteLevelPasswordEnable
 siteLevelPasswordEnable integer

A helyszintű jelszóvédelem engedélyezéséhez.
siteLevelPasscodeEnable
 siteLevelPasscodeEnable integer

Helyszintű pin-kódvédelem engedélyezése.
pin-kódUsingAuthApp
 passcodeUsingAuthApp integer

Azt jelzi, hogy a pin-kód hitelesítése használ-e hitelesítési alkalmazást.
sitePassword
 sitePassword string

A webhelyhez társított jelszó.
ipRestrictionEnable
 ipRestrictionEnable integer

Ip-korlátozások engedélyezése a webhely-hozzáféréshez.
availableIP
 availableIP string

A webhely eléréséhez engedélyezett IP-címek vesszővel tagolt listája.
highqDrive
 highqDrive integer

Azt jelzi, hogy engedélyezve van-e a HighQ Drive-integráció.
applySiteHomePage
 applySiteHomePage integer

Egyéni kezdőlap alkalmazása a webhelyre.
siteHomePage
 siteHomePage string

A webhely egyéni kezdőlapjának URL-címe.
siteHomePageType
 siteHomePageType integer

A kezdőlap típusa.
nextLoginSiteHomePage
 nextLoginSiteHomePage integer

A következő bejelentkezés beállítása a webhely kezdőlapjára.
applyDisplayContent
 applyDisplayContent integer

Megjelenítési tartalombeállítások alkalmazása.
displayContent
 displayContent string

A webhelyen megjelenítendő tartalom.
rssSecurity
 rssSecurity integer

RSS-hírcsatorna biztonsági szintje.
encryptedPassword
 encryptedPassword integer

Azt jelzi, hogy a webhely jelszava titkosítva van-e.
availableIPRangeCSV
 availableIPRangeCSV string

A webhely eléréséhez engedélyezett IP-címtartományok vesszővel tagolt listája.
siteModuleID
 siteModuleID integer

A helymodul azonosítója.
icalSecurity
 icalSecurity integer

iCal-adatcsatorna biztonsági szintje.
defaultDisplayContent
 defaultDisplayContent string

A webhelyen megjelenítendő alapértelmezett tartalom.
defaultEmailAlert
 defaultEmailAlert integer

Az alapértelmezett e-mail-riasztások engedélyezéséhez.
excelReportFooter
 excelReportFooter integer

Tartalmaz egy élőlábat az Excel-jelentésekben.
excelReportFooterText
 excelReportFooterText string

Az Excel-jelentések láblécében megjelenítendő szöveg.
announcementMLJSON
 announcementMLJSON string

JSON formátumú közlemények a webhelyhez.
sablon típusa
 templateType integer

A webhelyhez használt sablon típusa.
templateLicence
 templateLicence integer

A webhelysablon licenctípusa.
openChannelAppID
 openChannelAppID string

A nyílt csatorna integrációjának alkalmazásazonosítója.
itemid
 itemid integer

A webhelyhez társított elem azonosítója.
sitemetadatasheetid
 sitemetadatasheetid integer

A webhelyhez társított metaadatlap azonosítója.
mysite
 mysite boolean

Jelzi, hogy ez a felhasználó személyes webhelye-e.
lastaccesseddate
 lastaccesseddate string

A webhely legutóbbi elérésének dátuma és időpontja.
defaultViewerMetaDataTab
 defaultViewerMetaDataTab integer

A webhelymegjelenítő alapértelmezett metaadatainak lapja.
documentMetadataViewId
 documentMetadataViewId integer

dokumentum metaadatai a nézetazonosítóhoz.
folderMetadataViewId
 folderMetadataViewId integer

mappa metaadatai a nézetazonosítóhoz.
docSort
 docSort integer

A dokumentumok rendezési sorrendje.
folderSort
 folderSort integer

A mappák rendezési sorrendje.
defaultFolderRenderView
 defaultFolderRenderView integer

A mappák alapértelmezett nézetmódjának meghatározása.
isTaskAttachmentDefault
 isTaskAttachmentDefault integer

A feladatmellékletek alapértelmezett helye.
taskAttachmentDefaultFolderId
 taskAttachmentDefaultFolderId integer

A feladatmellékletek alapértelmezett helyeként kijelölt mappa egyedi azonosítója.
kedvenc
 favourite string

kedvenc állapota.
enabledocumentredaction
 enabledocumentredaction boolean

Megadja, hogy engedélyezve van-e a dokumentum-újrakifedés a webhelyen.
említéscsoportok
 mentiongroups integer

Az említett csoportok.
enablefilerelationships
 enablefilerelationships boolean

Azt jelzi, hogy engedélyezve vannak-e a fájlkapcsolatok.
filerelationshipsitepermissionlevel
 filerelationshipsitepermissionlevel integer

A fájlkapcsolatok kezeléséhez szükséges jogosultsági szint.

ModuleDBO

Name Elérési út Típus Description
otthon
 home HomeDBO
tevékenység
 activity ActivityDBO
dokumentum
 document DocumentDBO
blog
 blog BlogDBO
wiki
 wiki WikiDBO
feladat
 task TaskDBO
esemény
 event EventDBO
adatlap
 isheet ISheetDBO
Minőségbiztosítási
 qa QaDBO
nép
 people PeopleDBO
contractexpress
 contractexpress ContractExpressDBO

HomeDBO

Name Elérési út Típus Description
engedélyez
 enable string

A HomeDBO állapotának engedélyezése.

ActivityDBO

Name Elérési út Típus Description
engedélyez
 enable string

Az ActivityDBO állapotának engedélyezése.
mikroblog
 microblog string

Az ActivityDBO-hoz társított mikroblog-tartalom.

BlogDBO

Name Elérési út Típus Description
blogTitle
 blogTitle string

A blogbejegyzés címe.
blogContent
 blogContent string

A blogbejegyzés tartalma.
showComment
 showComment integer

a megjegyzés megjelenítése.
címkék listája
 tagList array of string

A bloghoz társított címkék listája.
állapot
 status integer

a blogbejegyzés állapota.
siteID
 siteID integer

A társított webhely azonosítója.
szerző
 author string

A blog szerzője.
categoryList
 categoryList array of string

A blogbejegyzéshez rendelt kategóriák.
notificationTypeID
 notificationTypeID integer

Az értesítéstípus azonosítója.
üzenet
 message string

A bloghoz kapcsolódó üzenettartalmak.
messageCode
 messageCode integer

Az üzenethez társított kód.
külső azonosító
 externalID string

A bloghoz társított külső azonosító.
közzététel dátuma
 publishDate string

A blog közzétételi dátuma.
processtype
 processtype string

A bloghoz társított folyamattípus.
engedélyez
 enable string

A BlogDBO állapotának engedélyezése.

WikiDBO

Name Elérési út Típus Description
wikiid
 wikiid integer

A wiki egyedi azonosítója.
currentversionid
 currentversionid integer

A wiki aktuális verziójának azonosítója
parentwikiid
 parentwikiid integer

A szülő wiki azonosítója.
wikititle
 wikititle string

A wiki címe.
wikicontent
 wikicontent string

A wiki tartalma.
showcomment
 showcomment integer

Jelzi, hogy a megjegyzések engedélyezve vannak-e.
createddate
 createddate string

A wiki létrehozásának dátuma.
módosítottdátum
 modifieddate string

A wiki utolsó módosítási dátuma.
címkelista
 taglist string

A wikihöz társított címkék vesszővel tagolt listája.
wikipath
 wikipath string

A wiki elérésének elérési útja.
wikidraftid
 wikidraftid integer

A wiki piszkozatverziójának azonosítója.
piszkozattípus
 drafttype string

A wikihez társított vázlat típusa.
állapot
 status integer

A wiki aktuális állapota.
wikiversionid
 wikiversionid integer

A wiki verzióazonosítója.

TaskDBO

Name Elérési út Típus Description
index
 index string

A tevékenység indexe vagy azonosítója.
parenttaskid
 parenttaskid integer

A szülőfeladat azonosítója.
taskid
 taskid integer

A tevékenység egyedi azonosítója.
title
 title string

A feladat címe.
leírás
 description string

A tevékenység részletes leírása.
esedékesség
 duedate string

A tevékenység befejezésének határideje.
startdate
 startdate string

A tevékenység kezdeményezésének kezdő dátuma.
mattermaptaskid
 mattermaptaskid string

Azonosító, amely az anyagtérkép-feladathoz kapcsolódik.
típus
 type string

A tevékenység típusa vagy kategóriája.
dependon
 dependenton string

Tevékenységek, amelyektől ez a tevékenység függ.
daysfromdependent
 daysfromdependent string

A függő tevékenység napjainak száma.
ignoreweekend
 ignoreweekend integer

Azt jelzi, hogy a hétvégek figyelmen kívül vannak-e hagyva az ütemezésben.
duration
 duration integer

A tevékenység befejezésének időtartama.
erőforrás
 resource string

A tevékenységhez rendelt erőforrások.

EventDBO

Name Elérési út Típus Description
eventTitle
 eventTitle string

Az esemény címe.
eventContent
 eventContent string

Az esemény tartalma.
showComment
 showComment integer

Jelzi, hogy engedélyezve vannak-e megjegyzések az eseményhez.
címkék listája
 tagList array of string

Az eseményhez társított címkék listája.
állapot
 status integer

Az esemény aktuális állapota.
siteID
 siteID integer

A webhely azonosítója.
kapcsolatfelvétel
 contact string

Az esemény kapcsolattartási adatai.
categoryList
 categoryList array of string

Kategóriák, amelyek alatt az esemény szerepel.
notificationTypeID
 notificationTypeID integer

Az eseményhez kapcsolódó értesítési típus.
üzenet
 message string

Az esemény üzenete.
messageCode
 messageCode integer

Az esemény üzenetkódja.
külső azonosító
 externalID string

A külső azonosító.
startDate
 startDate string

Az esemény kezdő dátuma.
befejezési dátum
 endDate string

Az esemény záró dátuma.
startTime
 startTime string

Az esemény kezdő időpontja.
endTime
 endTime string

Az esemény záró időpontja.
hely
 location string

Az esemény helye.
szerző
 author string

Az esemény szerzője.
processtype
 processtype string

Az esemény folyamatideje.
engedélyez
 enable string

Az Engedélyezés az esemény.

ISheetDBO

Name Elérési út Típus Description
azonosító
 id integer

Az iSheet egyedi azonosítója.
title
 title string

Az iSheet címe.
leírás
 description string

Az adatlap leírása.
állapot
 status string

Az adatlap állapota.
accesstype
 accesstype string

Az adatlap hozzáférési típusa.
típus
 type string

Az adatlap típusa.
viewlink
 viewlink string

Hivatkozás az iSheet megtekintéséhez.
allowsections
 allowsections string

A szakaszok engedélyezettek-e.
allowlookup
 allowlookup string

Engedélyezve vannak-e a keresési mezők.
displayisheet
 displayisheet string

Az iSheet megjelenítési beállításai.
searchasdefaultview
 searchasdefaultview string

Azt jelzi, hogy a keresés alapértelmezett nézet-e.
enableversion
 enableversion string

Verziószámozást engedélyező jelző.
enablesheetalerter
 enablesheetalerter string

Jelölő a lapriasztások engedélyezéséhez.
alertercondition
 alertercondition string

Riasztások aktiválásának feltételei.
overrideitemmodifieddate
 overrideitemmodifieddate string

Felülbírálja a módosított dátumjelölőt.
enablebulkinsertupdate
 enablebulkinsertupdate string

Tömeges beszúrás/frissítés engedélyezése.
mezőleírók
 fielddescriptions string

Az iSheet mezőleírásai.
enablerowlocking
 enablerowlocking string

Sorszintű zárolás engedélyezése.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Többsoros szövegjelölő csonkálása.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

Többsoros csonkolás karakterkorlátja.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

A választható listaértékek újrafelhasználásának engedélyezése.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

A pontszámlista értékeinek újbóli felhasználásának engedélyezése.
allowIsheetComments
 allowIsheetComments string

Megjegyzések engedélyezése az iSheetben.
shareRecordsLimit
 shareRecordsLimit integer

A megosztható rekordok korlátja.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Engedélyezett rekordok megosztási korlátja.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Űrlapmegosztás engedélyezése rekordok hozzáadásához.
rekordszám
 recordcount string

Aktuális rekordszám.
sheettypeid
 sheettypeid integer

Az iSheet típusazonosítója

QaDBO

Name Elérési út Típus Description
engedélyez
 enable string

A minőségbiztosítási funkciók engedélyezése.

PeopleDBO

Name Elérési út Típus Description
személy
 person array of PersonDBO

PersonDBO

Name Elérési út Típus Description
userid
 userid integer

Felhasználói azonosító.
e-mail
 email string

e-mail-cím.
httpavatar
 httpavatar string

Az avatar HTTP URL-címe.
megtestesülés
 avatar string

Avatar kép.
userlink
 userlink string

Hivatkozás a felhasználói profilra.
httplink
 httplink string

HTTP-hivatkozás a felhasználói profilra.
phone
 phone string

Telefonszám.
mobil
 mobile string

Mobilszám.
osztály
 department string

A felhasználó részlege.

ContractExpressDBO

Name Elérési út Típus Description
engedélyez
 enable string

A Contract Express integrációjának engedélyezése.

FolderDBOV2

Name Elérési út Típus Description
név
 name string

Mappa neve.
leírás
 description string

Mappa leírása.
parentFolderID
 parentFolderID integer

Szülőmappa-azonosító.
accessInherited
 accessInherited integer

Hozzáférés öröklési állapota.
batchID
 batchID string

Batch-azonosító
DMS
 dms DmsDBO
azonosító
 id integer

Mappaazonosító.
hivatkozás
 link string

Mappahivatkozás.
createddate
 createddate string

Létrehozás dátuma.
módosítottdátum
 modifieddate string

Módosított dátum.
gyermek
 child integer

Gyermekmappák.
filecount
 filecount integer

Fájlok száma.
létrehozta
 createdby UserDBO
módosítva
 modifiedby UserDBO
mappaazonosító
 folderid integer

Mappaazonosító.
dmsfolderid
 dmsfolderid string

DMS-mappaazonosító.
siteid
 siteid integer

Webhelyazonosító
hely
 location string

Mappa helye.
engedély
 permission PermissionDBO
contentstatus
 contentstatus integer

Tartalom állapota.
számláló
 autonumbering string

Automatikus számozási konfiguráció.
mappaméret
 foldersize string

Mappaméret.
sharedstatus
 sharedstatus integer

Megosztás állapota.
kedvencstatus
 favouritestatus integer

Kedvenc állapot.
mappatípus
 foldertype string

Mappa típusa.
cikkszám
 itemId integer

Elemazonosító.
folderMetadataSheetId
 folderMetadataSheetId integer

A lapazonosító mappa metaadatai.

UserDBO

Name Elérési út Típus Description
keresztnév
 firstname string

Keresztnév.
vezetéknév
 lastname string

Vezetéknév.
e-mail
 email string

Email cím.
userid
 userid integer

Felhasználói azonosító.

PermissionDBO

Name Elérési út Típus Description
nézet
 view integer

Megtekintési engedély.
szerkesztés
 edit integer

Szerkesztési engedély.
töröl
 delete integer

Engedély törlése.
addEditAllFiles
 addEditAllFiles integer

Az összes fájl engedélyének hozzáadása/szerkesztése.
adminisztrátor
 admin integer

Rendszergazdai engedély.
viewAllFiles
 viewAllFiles integer

Az összes fájl engedélyének megtekintése.
disableSave
 disableSave integer

tiltsa le a mentési engedélyt.
uploadFile
 uploadFile integer

fájlengedély feltöltése.
updateFile
 updateFile integer

fájlengedély frissítése.
deleteFile
 deleteFile integer

Fájlengedély törlése.

ProgressiveKeyDBO

Name Elérési út Típus Description
progressivekey
 progressivekey string

A progresszív műveletek kulcsa.
siteid
 siteid integer

A webhely azonosítója.
progressivekeystatus
 progressivekeystatus string

A progresszív kulcs állapota.
userid
 userid integer

A felhasználó azonosítója.
responsebody
 responsebody string

A válasz törzse.
üzenet
 message string

Üzenet tartalma.
üzenetkód
 messagecode string

Az üzenethez társított kód.
integrationResponseDBO
 integrationResponseDBO IntegrationResponseDBO
columns
 columns ColumnErrorsDBO
items
 items ItemErrorsDBO
importisheetteplate
 importisheettemplate importISheetTemplateDBO
hiba
 error ErrorDBO
tartalomtípus
 contentType string

Tartalom típusa.
failedEntities
 failedEntities integer

Sikertelen entitások száma.
downloadlink
 downloadlink string

Tartalom letöltésére mutató hivatkozás.
melléklet
 attachment Attachment
hivatkozás
 link string

Társított hivatkozás.
documentid
 documentid integer

A dokumentum azonosítója.
progresskey
 progresskey string

Folyamatjelző kulcs a nyomon követéshez.
progresskeystatus
 progresskeystatus string

A folyamatjelző kulcs állapota.

IntegrationResponseDBO

Name Elérési út Típus Description
integrationResponseUsersObject
 integrationResponseUsersObject IntegrationResponseUsersObject
failedEntities
 failedEntities integer

A nem feldolgozott entitások száma.
successEntities
 successEntities integer

A sikeresen feldolgozott entitások száma.

IntegrationResponseUsersObject

Name Elérési út Típus Description
felhasználó
 user array of IntegrationUserDBO

ColumnErrorsDBO

Name Elérési út Típus Description
oszlop
 column array of ColumnErrorDBO
failedEntities
 failedEntities integer

Az oszlophibák miatt meghiúsult entitások száma.
successEntities
 successEntities integer

A sikeresen feldolgozott entitások száma.

ColumnErrorDBO

Name Elérési út Típus Description
index
 index integer

Az oszlop indexpozíciója hibával.
oszlopazonosító
 columnid integer

Az oszlop egyedi azonosítója hibával.
név
 name string

A hibás oszlop neve.
állapot
 status string

A hibafeltételt jelző állapot.
állapotkód
 statuscode string

A hibaállapotnak jelölő kód.
üzenet
 message string

Részletes hibaüzenet.

ItemErrorsDBO

Name Elérési út Típus Description
elem
 item array of ItemErrorDBO
failedEntities
 failedEntities integer

Az elemhibák miatt meghiúsult entitások száma.
successEntities
 successEntities integer

Az elemhibák ellenére sikeresen feldolgozott entitások száma.

ItemErrorDBO

Name Elérési út Típus Description
index
 index integer

Az elem indexpozíciója hibával.
columns
 columns ColumnErrorsDBO
itemid
 itemid string

Az elem egyedi azonosítója hibával.
externalid
 externalid string

Az elemhez társított külső azonosító.
azonosító
 id string

Az elem belső azonosítója.
név
 name string

A hibával rendelkező elem neve.
állapot
 status string

A hibafeltételt jelző állapot.
állapotkód
 statuscode string

A hibaállapotnak jelölő kód.
üzenet
 message string

Részletes hibaüzenet.
successdeletedcount
 successdeletedcount integer

A sikeresen törölt entitások száma.
hibaszám
 failurecount integer

A nem feldolgozott entitások száma.
failedEntities
 failedEntities integer

Az elemhibák miatt meghiúsult entitások száma.
successEntities
 successEntities integer

A sikeresen feldolgozott entitások száma.

importISheetTemplateDBO

Name Elérési út Típus Description
linkedtemplateid
 linkedtemplateid integer

A csatolt sablon azonosítója.
aliasnév
 aliasname string

A sablon aliasneve.
linkedisheet
 linkedisheet string

A csatolt beviteli lap azonosítója.
importdata
 importdata string

A sablonból importálandó adatok.
appendisheetname
 appendisheetname string

Annak a lapnak a neve, amelyhez adatokat szeretne hozzáfűzni.
templateparametergroups
 templateparametergroups ISheetTemplateParameterGroups
templateSheetIdMap
 templateSheetIdMap object
sablon azonosítója
 templateId integer

A sablon azonosítója.
templateTitle
 templateTitle string

A sablon címe.
viewID-k
 viewIDs string

A nézetazonosítók vesszővel tagolt listája.

ISheetTemplateParameterGroups

Name Elérési út Típus Description
templateparametergroup
 templateparametergroup array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Name Elérési út Típus Description
templateruleid
 templateruleid integer

Isheet Template Parameter Group.
templateparameter
 templateparameter array of ISheetTemplateParameter

ISheetTemplateParameter

Name Elérési út Típus Description
azonosító
 id integer

Az adatlapsablon paraméter azonosítója.
név
 name string

Az adatlapsablon paraméter neve.
adat
 data string

az isheet-sablonparaméter adatai.

Attachment

Name Elérési út Típus Description
fájl
 file string

A fájl tartalma.
név
 name string

A melléklet neve.
sorrend
 order string

A melléklet sorrendje.
azonosító
 id integer

A melléklet egyedi azonosítója.
bővítmény
 extension string

Fájlkiterjesztés.
parentfolderid
 parentfolderid integer

A szülőmappa azonosítója.
filehttplink
 filehttplink string

HTTP-hivatkozás a fájl eléréséhez.
folderpath
 folderpath string

A fájlt tartalmazó mappa elérési útja.
folderhttplink
 folderhttplink string

HTTP-hivatkozás a mappára.
fájlméret
 filesize integer

A fájl mérete bájtban.
redactionStatus
 redactionStatus boolean

Azt jelzi, hogy a fájl újra ki van-e léptetve.
displayname
 displayname string

A melléklet megjelenítendő neve.
siteid
 siteid integer

A melléklethez társított webhely azonosítója.