HighQ (Vorschau)

Dieser Connector ermöglicht einen sicheren und authentifizierten Zugriff auf HighQ-APIs, wodurch die nahtlose Integration von Funktionen für die Zusammenarbeit und die Inhaltsverwaltung in benutzerdefinierte Workflows und Anwendungen ermöglicht wird. Sie unterstützt Die Dokumentautomatisierung, die Datensynchronisierung und die Workflow-Orchestrierung – die Unterstützung von Legal- und Professional Services-Teams zum Optimieren von Vorgängen, zur Reduzierung des manuellen Aufwands und zur Steigerung der Produktivität.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Copilot Studio	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)

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

Connectormetadaten
Herausgeber	Thomson Reuters Incorporated
Webseite	https://legal.thomsonreuters.com/en/products/highq
Datenschutzrichtlinie	https://www.thomsonreuters.com/en/privacy-statement
Kategorien	Zusammenarbeit; Inhalt und Dateien

HighQ

Überblick

HighQ bietet nahtlosen, sicheren, authentifizierten Zugriff auf HighQ-APIs. Dieser Connector ermöglicht eine nahtlose Interaktion mit verschiedenen HighQ-Diensten, einschließlich ISheet-Modul, Dokumentressourcen-APIs, ISheet-Administrator-API und Benutzervorgängen. Es wurde entwickelt, um die Integration mit der HighQ-Zusammenarbeitsplattform zu erleichtern und Funktionen wie das Abrufen und Erstellen von iSheet-Elementen, das Verwalten von Dokumentdateien und das Verwalten von Benutzerkonten zu ermöglichen.

Connectorversion: 1.0.0
Titel: HighQ
Beschreibung: Dieser Connector bietet nahtlosen, sicheren und authentifizierten Zugriff auf HighQ-APIs.
Kontakt:
- Name: Highq
- Website:HighQ-Support
- E-Mail:highq-support@thomsonreuters.com

Authentifizierung

Der Connector nutzt dynamische Umgebungsvariablen für sichere Konnektivität:

Host: @environmentVariables("highqt_host")
Basispfad: /@environmentVariables("highqt_instancename")/api
Client-ID:@environmentVariables("highqt_clientid")
Geheimer Clientschlüssel:@environmentVariables("highqt_clientsecret")

Ausführliche Authentifizierungsverfahren finden Sie im HighQ Technical Support-Portal , oder wenden Sie sich an den HighQ-Support.

Verbindervorgänge

ISheet-Modul

Abrufen von iSheet-Elementen
GET /{version}/isheet/{isheetid}/items
Ruft eine Liste von Elementen innerhalb des angegebenen iSheet ab.
Erstellen von iSheet-Elementen
POST /{version}/isheet/{isheetid}/items
Fügt neue Elemente in ein iSheet mit Unterstützung für mehrere iSheets und Statusverfolgung über progressive Schlüssel ein.

Dokumentressourcen-APIs

Abrufen von Dateiinformationen
GET /{version}/files/{fileid}
Ruft detaillierte Informationen zu einer bestimmten Datei auf der HighQ-Zusammenarbeitsplattform ab.
Hochladen einer Datei
POST /{version}/files/content
Lädt eine Datei in einen angegebenen Ordner hoch, wobei blockierte Uploads unterstützt werden, wenn die Content-Range Kopfzeile bereitgestellt wird.
Ordnerliste abrufen
GET /{version}/folders/{folderid}/items
Ruft eine Liste von Ordnern innerhalb des angegebenen Ordners mit Unterstützung für Sortierung und Paginierung ab.

ISheet-Administrator-API

Abrufen von iSheet-Spalten
GET /{version}/isheets/admin/{isheetid}/columns
Ruft Spaltenkonfigurationen für ein bestimmtes iSheet ab.

Benutzeroperationen

Benutzer abrufen
GET /{version}/users
Ruft eine Liste der Benutzer mit Unterstützung für Filterung, Paginierung und detaillierte Benutzerrollen ab.
Neuen Benutzer hinzufügen
POST /{version}/users
Erstellt ein neues Benutzerkonto mit erweiterten Attributen und Überprüfungen.
Archiv eines Benutzers
DELETE /{version}/users/{userid}
Archiviert einen vorhandenen Benutzer aus dem System.

Dokument- und Websiteverwaltung

Erstellen eines Ordners
POST /{version}/folders
Erstellt einen neuen Ordner unter einem angegebenen übergeordneten Ordner.
Dokumente verschieben
PUT /{version}/files/move
Verschiebt eine oder mehrere Dateien aus einem Ordner in einen anderen innerhalb derselben Website.
Websiteverwaltungsvorgänge:
- Vorhandene Gruppe zu Website hinzufügen: POST /{version}/sites/{siteid}/groups/{groupid}
- Websitegruppe aktualisieren: PUT /{version}/sites/{siteid}/groups/{groupid}
- Neue Website hinzufügen: POST /{version}/sites

Erste Schritte

Konfiguration:
- Definieren Sie die Umgebungsvariablen highqt_host und highqt_instancename in Ihrer Power Platform-Umgebung.
Authentifizierung:
- Befolgen Sie die Richtlinien von HighQ, um die sichere Authentifizierung für API-Anforderungen zu konfigurieren.
Verwendung:
- Importieren Sie highQ in Ihre Power Platform-Instanz.
- Nutzen Sie die verfügbaren Vorgänge nach Bedarf. Weitere Informationen finden Sie in den oben aufgeführten Vorgangszusammenfassungen.

Parameter und Einstellungen

Pfadparameter:
Schließen Sie erforderliche Parameter wie version, , isheetid, fileidfolderid, und userid ggf. ein.
Abfrageparameter:
Optionale Parameter wie sheetviewid, sortcolumnid, limit, und offset sind verfügbar, um API-Antworten zu verfeinern.
Body-Parameter:
Stellen Sie für Vorgänge, die einen Anforderungstext (z. B. das Erstellen von iSheet-Elementen oder -Benutzern) erfordern, sicher, dass die Anforderung den definierten Schemas entspricht (z isheetDBO. B. , , FolderDBOoder IntegrationUserDBO).

Problembehandlung und Einschränkungen

Fehlercodes:
Standard-HTTP-Statuscodes werden für alle Vorgänge verwendet:
- 200 für erfolgreiche Vorgänge
- 401 für nicht autorisierten Zugriff
- 403 für unzulässige oder Überprüfungsfehler
- 405 für ungültige HTTP-Methoden
- 500 für interne Serverfehler
  Ausführliche Fehlerbeschreibungen finden Sie in der einzelnen API-Dokumentation.
Einschränkungen:
Einige Endpunkte verfügen möglicherweise über Standardgrenzwerte (z. B. eine Standardeinstellung limit von 100 Datensätzen). Für das Sortieren und Filtern großer Datasets sind möglicherweise zusätzliche Parameter erforderlich.

Zusätzliche Ressourcen

Ausführlichere Informationen und erweiterte Dokumentation finden Sie unter:

HighQ Technical Support
Interne Dokumentation, die das HighQ-Connectorpaket begleitet.

Lizenzierung und Support

Für Lizenzierungsdetails und technischen Support:

Kontakt: Highq
Support-URL: HighQ Technical Support
Support-E-Mail: highq-support@thomsonreuters.com

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abrufen einer Liste von iSheet-Elementen

Dieser API-Aufruf ruft eine Liste von Elementen ab, die im angegebenen iSheet enthalten sind.

Abrufen einer Liste von Ordnern

Dieser API-Aufruf ruft eine Liste von Ordnern ab, die im angegebenen Ordner enthalten sind. Der Parameter "limit" legt die maximale Anzahl der zurückzugebenden Elemente fest, und der Parameter "offset" gibt die Startposition für den Datenabruf an. Standardwerte werden angewendet, wenn diese Parameter weggelassen werden, und die Ordner werden nach Erstellungsdatum in aufsteigender Reihenfolge zurückgegeben.

Abrufen von Dateiinformationen

Dieser API-Aufruf ruft detaillierte Informationen für eine angegebene Datei von der HighQ-Zusammenarbeitsplattform ab.

Abrufen von iSheet-Spalten

Dieser API-Aufruf ruft die Spalten ab, die dem angegebenen iSheet zugeordnet sind. Diese Funktionalität wird in API Version 3 und höher unterstützt.

Abrufen von Ordnerinformationen

Die Methode enthält Ordnerdetails der angegebenen Ordner-ID.

Archivbenutzer

Dieser API-Aufruf wird verwendet, um einen Benutzer im System zu archivieren.

Fehlercodes

Zusammenfassung	Referenzcode (vor V4)	Bezugscode (V4)
Die folgenden Benutzer sind nicht im System vorhanden.	110	110
Eine Benutzer-ID ist erforderlich.	109	109
Die Benutzer-ID weist nicht das richtige Format auf.	113	113
Die ID-Länge des Benutzers darf 50 Zeichen nicht überschreiten.	N/A	304

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

Benutzer hinzufügen

Dieser API-Aufruf wird verwendet, um dem System einen neuen Benutzer hinzuzufügen.
Hinweis:
1. Unterstützung für die folgenden neuen Felder hinzugefügt
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. Adresstag wurde in API Version 4 hinzugefügt

1

Zusammenfassung	Referenzcode (vor V4)	Bezugscode (V4)
E-Mail-Adresse ist erforderlich	101	101
Ungültige E-Mail-Adresse	104	104
Vorname ist erforderlich	102	102
Maximal zulässige Zeichen für den Vornamen müssen zwischen 1 und 100 sein.	102	352
Die E-Mail-Adresse des Sekretärs/Assistenten ist ungültig.	104	353
Status muss aktiv oder inaktiv sein	116	116
Die eingegebene Abteilung darf maximal 256 Zeichen lang sein.	N/A	354
Das eingegebene ifpartner-Attribut ist ungültig.	N/A	355
Das eingegebene Systemuser-Attribut ist ungültig.	N/A	356
Das eingegebene Usertypeid-Attribut ist ungültig.	N/A	357
Das eingegebene Langcode-Attribut ist ungültig.	N/A	358
Das eingegebene Quelltyp-Attribut ist ungültig. Gültige Werte sind "System", "Active Directory" oder "System Default".	N/A	359
Geben Sie bitte eine gültige Telefonnummer ein.	N/A	360
Geben Sie eine gültige Telefonnummer im Format {countrycode} ${areacode}${number} ein.	N/A	361
Geben Sie eine gültige Mobiltelefonnummer im Format {countrycode}${number} ein.	N/A	362
Geben Sie einen gültigen Landescode für Bürotelefone ein.	N/A	363
Die Landesvorwahl des Bürotelefons kann maximal 4 Ziffern enthalten.	N/A	364
Geben Sie eine gültige Bürotelefonvorwahl ein.	N/A	365
Die Bürotelefonvorwahl kann maximal 5 Ziffern haben.	N/A	366
Office-Telefonnummer sollte maximal 15 Ziffern aufweisen	N/A	368
Geben Sie einen gültigen Ländercode für Mobiltelefone ein.	N/A	369
Die Landesvorwahl des Mobiltelefons kann maximal 4 Ziffern aufweisen.	N/A	372
Geben Sie bitte eine gültige Mobiltelefonnummer ein.	N/A	373
Mobiltelefonnummer sollte maximal 20 Ziffern aufweisen	N/A	374
Domäne ist nicht vorhanden	105	105
E-Mails sind bereits im System vorhanden	111	111
Organisation bei selbst registrierter Domäne erwähnen	187	187
Organisation bei außergewöhnlicher Domäne erwähnen	115	115
Die Organisations-ID weist nicht das richtige Format auf.	112	112
Organisation ist nicht vorhanden	106	106
Domäne existiert in anderen Organisationen	114	114
Die eingegebene Adress-ID ist ungültig.	N/A	308
Der Name der sozialen Verknüpfung wurde im System nicht gefunden.	N/A	375
Der Name für soziale Netzwerke ist erforderlich.	N/A	376
Der Wert für soziale Netzwerke ist erforderlich.	N/A	377
Maximale Anzahl von Zeichen für sozialen Link muss zwischen 1 und 500 betragen.	N/A	378
Geben Sie den Namen für den benutzerdefinierten Link ein.	N/A	379
Der erforderliche benutzerdefinierte Linkwert	N/A	380
Max. Zeichen für den Benutzerdefinierten Linknamen müssen zwischen 1 und 500 liegen.	N/A	381
Max. Zeichen für benutzerdefinierte Verknüpfungswerte müssen zwischen 1 und 500 liegen.	N/A	382
Der Name des Nachrichtenlinks erforderlich	N/A	383
Der Name des Nachrichtenlinks wurde im System nicht gefunden.	N/A	384
Der wert für den Nachrichtenlink erforderlich	N/A	385
Max. Zeichen für den Nachrichtenlinkwert müssen zwischen 1 und 500 liegen.	N/A	386
Der Link für soziale Netzwerke ist deaktiviert.	N/A	408
Der Nachrichtenlink ist deaktiviert.	N/A	409
Der benutzerdefinierte Link ist deaktiviert.	N/A	410

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

Benutzerliste abrufen

Ruft eine Liste der Benutzer ab. Diese API ruft eine Liste der Benutzer aus dem System ab. ## Wichtige Features - Abrufen von Benutzerdetails mit mehreren Filteroptionen - Unterstützt Paginierung mit `limit` und `offset` - Neue Abfrageparameter und Felder, die in den letzten Versionen eingeführt wurden - Strukturierte Antwort mit Benutzerrollen und Attributen ## Neue Abfrageparameter (Version-Specific) - Eingeführt in V12: - `systemAdminSearch`Gibt `1`nur Benutzer mit der Systemadministratorrolle zurück. - Eingeführt in V18: - `userid`: Akzeptiert kommagetrennte Werte (CSV). ## Antworttextaktualisierungen - Neue Felder hinzugefügt: - , , , , `emaildomain`, `org`, `invitationsentcreatedby`, ,`createddatemodifiedbymodifieddate` , - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddate`,`usertypeidavatarpracticegroup` , - # `langcode` # Address Format Change (from V11) - Das `publicprofile` Tag wurde zur `dateOfBirth` Konsistenz umbenannt. `locationaddress` - Beispielantwort: `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>` ## Benutzerrollen (in API V11+eingeführt) – Beispielantwort: `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>` ## Limits & Offsets - Limit Behavior: - Default: `100` if no value is provided. - Wird verwendet `-1` , um alle Datensätze zurückzugeben. - Wenn der Wert kleiner als `-1`ist, wird standardmäßig auf `100`. - Offsetverhalten: - Standard: `0` Wenn kein Wert angegeben wird. - Wenn der Offset die Gesamtzahl der Datensätze überschreitet, wird standardmäßig zurück zu `0`. ## Neue Rollen eingeführt - V12: , `Basic UserAllow user to bypass XSS protection` - : `Allow user to manage Contract Express system groups`## Fehlercodes | Zusammenfassung | Bezugscode (Vor V4) | Referenzcode (V4) | |---------|----------------------|--------------| | Ungültige Eingabe für den Benutzerstatus (AKTIV, ARCHIVIERT, INAKTIV) | 147 | 147 | | Die Organisations-ID ist ungültig | N/A | 260 | | Ungültiger `neverinvited` Wert (true/false) | N/A | 387 | | Ungültiger `neverlogin` Wert (true/false) | N/A | 388 | | Ungültiger `groupids` Wert | N/A | 214 | | Ungültiger `notingroup` Wert (true/false) | N/A | 389 | | Ungültig `ordertype` (unterstützt: Name, Organisation, Status usw.) | N/A | 289 | | Ungültig `orderby` (unterstützt: asc, desc) | N/A | 290 | | Ungültiger `offset` Wert | 138 | 138 | | Ungültiger `limit` Wert | 137 | 137 | ## Hinweise – Ab V13 ist diese API für alle Benutzer geöffnet (zuvor auf Systemadministratoren beschränkt). - Ab V18 gibt das `userregistered2FA` Feld an, ob ein Benutzer sich für 2FA registriert hat. --- Diese Beschreibung folgt der Schemaformatierung Swagger 2.0 und sollte im Beschreibungsfeld im Benutzerdefinierten Connector-Schema platziert werden.

Dokumente verschieben

Diese API verschiebt mehrere Dateien von einem Ordner in einen anderen innerhalb derselben Website.

Hinzufügen einer vorhandenen Gruppe zur Website

Diese API-Methode fügt der Website eine vorhandene Systemgruppe hinzu.
Diese API wurde erweitert, um vorhandene grundlegende Systembenutzergruppen (vom System-/Organisationstyp) auf der Website hinzuzufügen.

Hochladen einer Datei

Dieser API-Aufruf lädt eine Datei in einen angegebenen Ordner auf der HighQ-Zusammenarbeitsplattform hoch. Es unterstützt blockierte Uploads, wenn der Inhaltsbereichsheader bereitgestellt wird.

Ordner erstellen

Diese API erstellt einen neuen Ordner innerhalb der angegebenen Website. Damit können Sie Ordnerdetails angeben und sicherstellen, dass der Ordner unter dem angegebenen übergeordneten Ordner erstellt wird.

So erstellen Sie das iSheet-Element

Dieser API-Aufruf wird verwendet, um iSheet-Element einzufügen. Mehrere iSheets können unterstützt werden.

Rufen Sie DIE API POST /api/3/progressivekeystatus/{progressive_key} auf, um den Status eines iSheet-Elements basierend auf einem progressiven Schlüssel abzurufen.

z. B. POST /api/{version}/progressivekeystatus/{progressive_key}

Name	Typ	Description
progressive_key	String	Schlüssel zum Überprüfen des Status Ihrer Aktion.

Antwort


              
              <progressiveKeyresponse>

               \t<Elemente>

                \t\t<Element>

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

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

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

                 \t\t\t<Nachrichtendatensatz>wurde erfolgreich</nachricht hinzugefügt>

                \t\t</item>

                \t\t<Element>

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

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

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

                 \t\t\t<Nachrichtendatensatz>wurde erfolgreich</nachricht hinzugefügt>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Website aktualisieren

Verwenden Sie diesen API-Endpunkt, um die Details einer vorhandenen Website zu aktualisieren. Die API unterstützt dieselben Felder, die in der Create Site API verwendet werden.

Diese Methode unterstützt mehrere Materienummern, die mit API Version 10 zur Website hinzugefügt werden. "matternos"-Tag gibt mehrere Materienummern mit schreibgeschützter Schreibweise an.

Version 18 weiter: Es ist eine Kategorie (Websitezweck) erforderlich. Wenn der Websitezweck ausgeblendet ist, wird eine Meldung angezeigt; andernfalls werden ausgeblendete Websitezwecke nicht zur Website hinzugefügt.

Jetzt kann der Websitebesitzer auch anderen Benutzern zugewiesen werden, aber sie müssen Websiteteilnehmer sein und eine Rolle höher als der Websiteadministrator haben.

Version 18 weiter: Der Websitebesitzer kann der Website andere Benutzer zur Website hinzufügen.

Ab API Version 19 wird ein neues Modul namens customPages eingeführt, das eng mit dem Heimmodul gekoppelt ist. Wenn der Wert des Startmoduls "True" lautet, muss "customPages" wahr sein und umgekehrt.

Bitte beachten Sie, dass alle Eigenschaften/Elemente, die die Websiteantwort erhalten, nicht aktualisierbar/einfügebar sind. In der folgenden Tabelle erfahren Sie, welche schreibgeschützt, aktualisierbar oder einfügebar sind.

Website hinzufügen

Verwenden Sie diese API, um eine neue Website zu erstellen. Das Websiteobjekt unterstützt nur Attribute, die in der Benutzeroberfläche zum Erstellen von Websites sichtbar sind.

Diese API erfordert websitename (und obligatorische Felder, die bei Bedarf auf ASP-Ebene konfiguriert sind), um eine neue Website zu erstellen.

Das Tag "module" stellt ein anderes Modul dar, das in der Website konfiguriert werden soll, wie es in Anforderungsattributen dargestellt wird.
So erstellen Sie eine Website anhand der Vorlage, indem Sie das Tag "sitetemplateid" übergeben
- Für weniger als Version 7 wird in der Anforderung kein Modul angegeben ("Modul"-Tag wird nicht übergeben), erfolgt die Konfiguration des Vorlagenmoduls. Wenn das Modultag mit der Konfiguration bereitgestellt wird, wird dies beachtet und wie in der Anforderung angegeben konfiguriert (anstatt die Vorlagenmodulkonfiguration zu verwenden)
- Für mehr als Version 7 wird ein Modul angegeben ("Modul"-Tag wird übergeben) oder nicht in der Anforderung, findet die Vorlagenmodulkonfiguration statt.

Diese Methode unterstützt das Hochladen des Websitebilds in diesem Aufruf nicht, die Unterstützung des Websitesymbols wird als separater Aufruf bereitgestellt.
Der Methodenaufruf erwartet eine vorhandene Kategorie-ID. Die Kategorie-ID sollte von der aufrufenden Anwendung durch einen früheren Aufruf der Websitekategorienschnittstelle abgerufen werden. Wenn in der Anforderung keine Kategorien angegeben werden, wird standardmäßig keine Kategorie (keine tatsächliche Kategorie) hinzugefügt.

Das Start- und Enddatum der Website sollte im Format "TT MMM JJJJ" vorliegen, und es ist NICHT UTC. Der API-Client fordert immer das aktuelle Datum an.

"landingpage" hat den Standardwert "Dateien (Stammordner)".
"Landingpage" erwartet drei verschiedene Wörter oder Identifikationen für das Dateimodul. Mögliche Werte sind:
- Dateien (Stammordner)
- Dateien (letzte Aktivität)
- Dateien (erweiterte Suche)
Die Methodenimplementierung unterstützt jetzt (ab 5.1) mehrsprachigen Websitenamen. API Version 6 oder höher <websitename> stellt den Anforderungstext basierend auf der Benutzereinstellungsreihenfolge dar. API-Version 5 oder ältere <Websitename> stellt standardmäßig englisch (UK) dar.
<sitenametranslations> stellt Websitenamen in jeder Sprache dar (Dies ist zusätzliches Tag in "Objekt selbst API" ab 5.1) API Version 6 oder höher, im Anforderungstext, Sie senden beide Tags, d. h. <websitename> und <sitenametranslations> , dann müssen wir Werte überprüfen, z. B. <Websitename> muss mit dem jeweiligen <Übersetzungstag> in Bezug auf die Spracheinstellung des Benutzers übereinstimmen. API 7 oder höher, Website, die anhand der Vorlage erstellt wurde, folgt Modulen aus der Quellvorlage und ignoriert die Modulliste, die im Anforderungstext gesendet wird.

Die Methodenimplementierung unterstützt jetzt das Erstellen von Websites anhand der Vorlage, indem das Tag "sitetemplateid" (alter Ansatz) bereitgestellt wird.

Bitte beachten Sie, dass die Unterstützung für das Erstellen von Websites mithilfe dieser API in Zukunft nicht mehr unterstützt wird. Verwenden Sie zum Erstellen einer Website anhand der Vorlage die neue API Erstellen einer Website anhand der Vorlage (/sites/templates/{templateid}/site), bei der es sich um eine lange Abfrage-API handelt (unterstützung für lange ausgeführte Anforderungen)

Diese Methode unterstützt mehrere Materienummern, die mit API Version 10 zur Website hinzugefügt werden. "matternos"-Tag gibt mehrere Materienummern mit schreibgeschützter Schreibweise an. Ältere Version (kleiner als Version 10) einzelner Materiennummer "matterno" entspricht der ersten Materienummer, die mehrere Materienummern auf der Website vorhanden ist.

Version 18 weiter: Es ist eine Kategorie (Websitezweck) erforderlich. Wenn der Websitezweck ausgeblendet ist, wird eine Meldung angezeigt; andernfalls werden ausgeblendete Websitezwecke nicht zur Website hinzugefügt.

Bis Version 17: Der Websitebesitzer ist der angemeldete Benutzer; keine anderen Benutzer können hinzugefügt werden.

Version 18 weiter: Der Websitebesitzer kann der Website andere Benutzer zur Website hinzufügen.

Ab API Version 19 wird ein neues Modul namens "customPages" eingeführt, das eng mit dem Heimmodul gekoppelt ist. Wenn der Wert des Heimmoduls "True" lautet, ist "customPages" also "true" und umgekehrt.

Websitegruppe aktualisieren

Diese API-Methode aktualisiert den Namen einer vorhandenen Gruppe auf einer Website.
Diese API wurde erweitert, um den Namen einer vorhandenen einfachen Benutzergruppe auf einer Website zu aktualisieren.

Abrufen einer Liste von iSheet-Elementen

Vorgangs-ID:: getISheetItems

Dieser API-Aufruf ruft eine Liste von Elementen ab, die im angegebenen iSheet enthalten sind.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Gibt die Verwendete API-Version an.
iSheet-ID	isheetid	True	integer	Gibt die eindeutige ID des iSheet an.
iSheet-Ansichts-ID	sheetviewid		integer	Gibt die ID der iSheet-Ansicht an. Wenn sie weggelassen wird, wird die Standardansicht zurückgegeben.
Spalten-ID sortieren	sortcolumnid		integer	Gibt die ID der Spalte an, die zum Sortieren der Ergebnisse verwendet wird.
Sortierreihenfolge	sortorder		integer	Gibt die Sortierreihenfolge an. Verwenden Sie z. B. 0 für aufsteigende Reihenfolge oder einen anderen Wert für absteigende Reihenfolge.
Datensatzlimit	limit		integer	Gibt die maximale Anzahl der zurückzugebenden Datensätze an; Der Standardwert ist 100, wenn nicht angegeben.
Datensatzversatz	offset		integer	Gibt die Startposition für den Datensatzabruf an; Der Standardwert ist 0, wenn nicht angegeben.
Alle Spalten einschließen	allColumnRequired		boolean	Ein Kennzeichen, das angibt, ob alle Spaltendaten unabhängig von der aktuellen Ansicht eingeschlossen werden sollen.
Ansichtseinschränkungen ignorieren	isIgnoreView		boolean	Ein Flag, das angibt, ob Anzeigeeinschränkungen beim Abrufen von Elementdaten ignoriert werden sollen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
isheet	isheet	array of object	Eine Liste von iSheet-Elementen.
Artikel-ID	isheet.itemId	string	Die eindeutige ID des Elements.
Daten	isheet.data	array of object	Detaillierte Daten des Elements.
Sequenz	isheet.data.sequence	string	Die Sequenznummer, die den Daten zugeordnet ist.
columnDisplayName	isheet.data.columnDisplayName	string	Der Anzeigename der Spalte.
value	isheet.data.value	string	Der in der Spalte enthaltene Wert.

Abrufen einer Liste von Ordnern

Vorgangs-ID:: getFolderList

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Gibt die Verwendete API-Version an.
Ordner-ID	folderid	True	string	Gibt die eindeutige ID des Ordners an.
Grenzwert für Elemente	limit		string	Gibt die maximale Anzahl der zurückzugebenden Elemente an.
Elemente versetzt	offset		string	Gibt die Startposition für die zurückgegebenen Elemente an.
Sortierreihenfolgerichtung	orderby		string	Gibt die Reihenfolgesrichtung für das Sortieren von Elementen an. Verwenden Sie 'asc' für aufsteigende Reihenfolge oder 'desc' für absteigende Reihenfolge.
Sortiermerkmal	ordertype		string	Gibt das Kriterium zum Sortieren von Elementen an, z. B. Name, Autor oder Datum der letzten Änderung.
Ordnerstatusinformationen einschließen	statusinfo		boolean	Gibt an, ob zusätzliche Ordnerstatusinformationen eingeschlossen werden sollen. Der Standardwert ist "false".
Intelligente Ordner einschließen	includesmartfolder		boolean	Gibt an, ob intelligente Ordner in die zurückgegebene Liste eingeschlossen werden sollen. Der Standardwert ist "false".

Gibt zurück

Name	Pfad	Typ	Beschreibung
Ordner	folder	array of object
items	folder	object

Abrufen von Dateiinformationen

Vorgangs-ID:: getDocumentInfo

Dieser API-Aufruf ruft detaillierte Informationen für eine angegebene Datei von der HighQ-Zusammenarbeitsplattform ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Gibt die Verwendete API-Version an.
Datei-ID	fileid	True	string	Gibt die eindeutige ID der Datei an.
Neuestes DMS-Info-Flag	lastdmsinfo		boolean	Gibt an, ob die neuesten Informationen aus dem Dokumentverwaltungssystem abgerufen werden sollen.
Ordnertyp	foldertype		string	Gibt den Ordnertyp an, falls zutreffend.
Dateistatusinformationen einschließen	statusinfo		boolean	Gibt an, ob zusätzliche Dateistatusinformationen wie freigegebener Status, Favoritenstatus, Aufgabenanzahl und "Gefällt mir"-Status eingeschlossen werden sollen. Der Standardwert ist "false".
E-Mail-Metadaten einschließen	emailmetadata		boolean	Gibt an, ob E-Mail-Metadaten wie Absender, Empfänger und Zeitstempel eingeschlossen werden sollen. Der Standardwert ist "false".

Gibt zurück

Body: DocumentDBO

Abrufen von iSheet-Spalten

Vorgangs-ID:: getIsheetColumns

Dieser API-Aufruf ruft die Spalten ab, die dem angegebenen iSheet zugeordnet sind. Diese Funktionalität wird in API Version 3 und höher unterstützt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
iSheet-ID	isheetid	True	integer	Gibt die eindeutige ID des iSheet an, für die Spalten erforderlich sind.
API-Version	version	True	string	Gibt die Verwendete API-Version an.
iSheet-Ansichts-ID	sheetviewid		string	Gibt die ID der iSheet-Ansicht an. Wenn sie weggelassen wird, werden alle Spalten zurückgegeben.
Löschen von iSheet-Spalten einschließen	onlyForDeletedIsheet		boolean	Gibt an, ob Spalten aus einem gelöschten iSheet eingeschlossen werden sollen. Der Standardwert ist "false".

Gibt zurück

Body: columns

Abrufen von Ordnerinformationen

Vorgangs-ID:: getFolderInfo

Die Methode enthält Ordnerdetails der angegebenen Ordner-ID.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Version der API
Ordner-ID	folderid	True	string	folderID
Statusinformationen	statusinfo		boolean	Mit dem Statusinfo-Parameter können Sie auf zusätzliche Informationen zum Ordner zugreifen. Die verfügbaren Informationen umfassen den freigegebenen Status, den Favoritenstatus für angemeldeten Benutzer.

Gibt zurück

Body: FolderDBOV2

Archivbenutzer

Vorgangs-ID:: deleteUser

Dieser API-Aufruf wird verwendet, um einen Benutzer im System zu archivieren.

Fehlercodes

Zusammenfassung	Referenzcode (vor V4)	Bezugscode (V4)
Die folgenden Benutzer sind nicht im System vorhanden.	110	110
Eine Benutzer-ID ist erforderlich.	109	109
Die Benutzer-ID weist nicht das richtige Format auf.	113	113
Die ID-Länge des Benutzers darf 50 Zeichen nicht überschreiten.	N/A	304

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

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Version der API
Benutzer-ID	userid	True	string	Benutzer-ID

Benutzer hinzufügen

Vorgangs-ID:: createUser

Zusammenfassung	Referenzcode (vor V4)	Bezugscode (V4)
E-Mail-Adresse ist erforderlich	101	101
Ungültige E-Mail-Adresse	104	104
Vorname ist erforderlich	102	102
Maximal zulässige Zeichen für den Vornamen müssen zwischen 1 und 100 sein.	102	352
Die E-Mail-Adresse des Sekretärs/Assistenten ist ungültig.	104	353
Status muss aktiv oder inaktiv sein	116	116
Die eingegebene Abteilung darf maximal 256 Zeichen lang sein.	N/A	354
Das eingegebene ifpartner-Attribut ist ungültig.	N/A	355
Das eingegebene Systemuser-Attribut ist ungültig.	N/A	356
Das eingegebene Usertypeid-Attribut ist ungültig.	N/A	357
Das eingegebene Langcode-Attribut ist ungültig.	N/A	358
Das eingegebene Quelltyp-Attribut ist ungültig. Gültige Werte sind "System", "Active Directory" oder "System Default".	N/A	359
Geben Sie bitte eine gültige Telefonnummer ein.	N/A	360
Geben Sie eine gültige Telefonnummer im Format {countrycode} ${areacode}${number} ein.	N/A	361
Geben Sie eine gültige Mobiltelefonnummer im Format {countrycode}${number} ein.	N/A	362
Geben Sie einen gültigen Landescode für Bürotelefone ein.	N/A	363
Die Landesvorwahl des Bürotelefons kann maximal 4 Ziffern enthalten.	N/A	364
Geben Sie eine gültige Bürotelefonvorwahl ein.	N/A	365
Die Bürotelefonvorwahl kann maximal 5 Ziffern haben.	N/A	366
Office-Telefonnummer sollte maximal 15 Ziffern aufweisen	N/A	368
Geben Sie einen gültigen Ländercode für Mobiltelefone ein.	N/A	369
Die Landesvorwahl des Mobiltelefons kann maximal 4 Ziffern aufweisen.	N/A	372
Geben Sie bitte eine gültige Mobiltelefonnummer ein.	N/A	373
Mobiltelefonnummer sollte maximal 20 Ziffern aufweisen	N/A	374
Domäne ist nicht vorhanden	105	105
E-Mails sind bereits im System vorhanden	111	111
Organisation bei selbst registrierter Domäne erwähnen	187	187
Organisation bei außergewöhnlicher Domäne erwähnen	115	115
Die Organisations-ID weist nicht das richtige Format auf.	112	112
Organisation ist nicht vorhanden	106	106
Domäne existiert in anderen Organisationen	114	114
Die eingegebene Adress-ID ist ungültig.	N/A	308
Der Name der sozialen Verknüpfung wurde im System nicht gefunden.	N/A	375
Der Name für soziale Netzwerke ist erforderlich.	N/A	376
Der Wert für soziale Netzwerke ist erforderlich.	N/A	377
Maximale Anzahl von Zeichen für sozialen Link muss zwischen 1 und 500 betragen.	N/A	378
Geben Sie den Namen für den benutzerdefinierten Link ein.	N/A	379
Der erforderliche benutzerdefinierte Linkwert	N/A	380
Max. Zeichen für den Benutzerdefinierten Linknamen müssen zwischen 1 und 500 liegen.	N/A	381
Max. Zeichen für benutzerdefinierte Verknüpfungswerte müssen zwischen 1 und 500 liegen.	N/A	382
Der Name des Nachrichtenlinks erforderlich	N/A	383
Der Name des Nachrichtenlinks wurde im System nicht gefunden.	N/A	384
Der wert für den Nachrichtenlink erforderlich	N/A	385
Max. Zeichen für den Nachrichtenlinkwert müssen zwischen 1 und 500 liegen.	N/A	386
Der Link für soziale Netzwerke ist deaktiviert.	N/A	408
Der Nachrichtenlink ist deaktiviert.	N/A	409
Der benutzerdefinierte Link ist deaktiviert.	N/A	410

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

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Version der API
index	index		integer	Eindeutiger Index für den Benutzer.
userid	userid		integer	Eindeutiger Bezeichner für den Benutzer.
Vorname	firstname		string	Vorname des Benutzers.
Nachname	lastname		string	Nachname des Benutzers.
practicegroup	practicegroup		string	Übungsgruppe, zu der der Benutzer gehört.
langcode	langcode		string	Sprachcode des Benutzers.
localeID	localeID		string	Gebietsschema-ID des Benutzers.
publicprofile	publicprofile		string	Öffentliches Profil des Benutzers.
pwpid	pwpid		string	PWP-ID des Benutzers.
usertypeid	usertypeid		string	Benutzertyp-ID.
systemuser	systemuser		string	Systembenutzerkennzeichnung.
E-Mail	email		string	Email Adresse des Benutzers.
phone	phone		string	Telefonnummer des Benutzers.
mobile	mobile		string	Mobiltelefonnummer des Benutzers.
Abteilung	department		string	Abteilung des Benutzers.
Org	org		string	Die Organisation, zu der der Benutzer gehört.
addressline1	addressline1		string	Erste Zeile der Adresse.
addressline2	addressline2		string	Zweite Zeile der Adresse.
addressline3	addressline3		string	Dritte Zeile der Adresse.
city	city		string	Stadt der Adresse.
Staat	state		string	Der Status der Adresse.
country	country		string	Land der Adresse.
Postleitzahl	postcode		string	Postleitzahl der Adresse.
addressid	addressid		string	Eindeutiger Bezeichner für die Adresse.
addressline1	addressline1		string	Erste Zeile der Adresse.
addressline2	addressline2		string	Zweite Zeile der Adresse.
addressline3	addressline3		string	Dritte Zeile der Adresse.
city	city		string	Stadt der Adresse.
Staat	state		string	Der Status der Adresse.
country	country		string	Land der Adresse.
Postleitzahl	postCode		string	Postleitzahl der Adresse.
knownas	knownas		string	Alternativer Name oder Spitzname für die Adresse.
Erfahrung	experience		array of string
id	id		string	Link-ID
name	name		string	Linkname.
value	value		string	Linkwert.
id	id		string	Link-ID
name	name		string	Linkname.
value	value		string	Linkwert.
id	id		string	Link-ID
name	name		string	Linkname.
value	value		string	Linkwert.
img	img		string
reportsto	reportsto		string
Metadatenname	metadataname		array of string
Metadatenwert	metadatavalue		array of string
group	group		array of string
externalid	externalid		string	Externe ID des Benutzers.
Jobtitle	jobtitle		string	Position des Benutzers.
Sekretärname	secretaryname		string	Name des Sekretärs des Benutzers.
Secretarymail	secretarymail		string	E-Mail-Adresse des Sekretärs des Benutzers.
Spezialitäten	specialities		string	Besonderheiten des Benutzers.
title	title		string	Der Titel des Benutzers.
3.000	goesby		string	bevorzugter Name des Benutzers.
Nachsilbe	suffix		string	Suffix des Benutzernamens.
atomlink	atomlink		string	Atom-Link, der dem Benutzer zugeordnet ist.
bio	bio		string	Biografie des Benutzers.
dateOfBirth	dateOfBirth		string	Geburtsdatum des Benutzers.
link	link		string	Dem Benutzer zugeordneter Link.
status	status		string	Status des Benutzers.
Statuscode	statuscode		string	Statuscode des Benutzers.
message	message		string	Nachricht, die dem Benutzer zugeordnet ist.
Sourcetype	sourcetype		string	Quelltyp des Benutzers.
orgid	orgid		string	Organisations-ID.
ifpartner	ifpartner		string	Partnerkennzeichnung.
emaildomain	emaildomain		string	E-Mail-Domäne des Benutzers.
einladungsent	invitationsent		string	Gesendete Einladungskennzeichnung.
Erstellt von	createdby		string	Benutzer, der den Datensatz erstellt hat.
createddate	createddate		string	Datum, an dem der Datensatz erstellt wurde.
geändertvon	modifiedby		string	Benutzer, der den Datensatz geändert hat.
modifieddate	modifieddate		string	Datum, an dem der Datensatz geändert wurde.
lastlogindate	lastlogindate		string	Datum der letzten Anmeldung.
invalidlogins	invalidlogins		string	Anzahl ungültiger Anmeldeversuche.
publicwebsiteprofileid	publicwebsiteprofileid		string	Profil-ID der öffentlichen Website.
resetpassworddate	resetpassworddate		string	Datum, an dem das Kennwort zurückgesetzt wurde.
Avatar	avatar		string	Avatarbild-URL.
followingcount	followingcount		integer	Anzahl der Benutzer, die gefolgt werden.
Followercount	followercount		integer	Anzahl der Follower.
Folgende	following		boolean	Folgende Kennzeichnung.
role	role		string	Rolle des Benutzers.
isbasicuser	isbasicuser		string	Standardbenutzerkennzeichnung.
encryptedUserId	encryptedUserId		string	Verschlüsselte Benutzer-ID.
selbstregistern	selfregistered		integer	Selbst registrierte Kennzeichnung.
registeredWith2FA	registeredWith2FA		string	Zweistufige Authentifizierungsregistrierungskennzeichnung.
isIntern	isInternal		integer	Interne Benutzerkennzeichnung.
orgName	orgName		string	Name der Organisation.

Gibt zurück

Body: IntegrationUserDBO

Benutzerliste abrufen

Vorgangs-ID:: getAllSystemUsers

Ruft eine Liste der Benutzer ab. Diese API ruft eine Liste der Benutzer aus dem System ab. ## Wichtige Features - Abrufen von Benutzerdetails mit mehreren Filteroptionen - Unterstützt Paginierung mit `limit` und `offset` - Neue Abfrageparameter und Felder, die in den letzten Versionen eingeführt wurden - Strukturierte Antwort mit Benutzerrollen und Attributen ## Neue Abfrageparameter (Version-Specific) - Eingeführt in V12: - `systemAdminSearch`Gibt `1`nur Benutzer mit der Systemadministratorrolle zurück. - Eingeführt in V18: - `userid`: Akzeptiert kommagetrennte Werte (CSV). ## Antworttextaktualisierungen - Neue Felder hinzugefügt: - , , , , `emaildomain`, `org`, `invitationsentcreatedby`, ,`createddatemodifiedbymodifieddate` , - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddate`,`usertypeidavatarpracticegroup` , - # `langcode` # Address Format Change (from V11) - Das `publicprofile` Tag wurde zur `dateOfBirth` Konsistenz umbenannt. `locationaddress` - Beispielantwort: `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>` ## Benutzerrollen (in API V11+eingeführt) – Beispielantwort: `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>` ## Limits & Offsets - Limit Behavior: - Default: `100` if no value is provided. - Wird verwendet `-1` , um alle Datensätze zurückzugeben. - Wenn der Wert kleiner als `-1`ist, wird standardmäßig auf `100`. - Offsetverhalten: - Standard: `0` Wenn kein Wert angegeben wird. - Wenn der Offset die Gesamtzahl der Datensätze überschreitet, wird standardmäßig zurück zu `0`. ## Neue Rollen eingeführt - V12: , `Basic UserAllow user to bypass XSS protection` - : `Allow user to manage Contract Express system groups`## Fehlercodes | Zusammenfassung | Bezugscode (Vor V4) | Referenzcode (V4) | |---------|----------------------|--------------| | Ungültige Eingabe für den Benutzerstatus (AKTIV, ARCHIVIERT, INAKTIV) | 147 | 147 | | Die Organisations-ID ist ungültig | N/A | 260 | | Ungültiger `neverinvited` Wert (true/false) | N/A | 387 | | Ungültiger `neverlogin` Wert (true/false) | N/A | 388 | | Ungültiger `groupids` Wert | N/A | 214 | | Ungültiger `notingroup` Wert (true/false) | N/A | 389 | | Ungültig `ordertype` (unterstützt: Name, Organisation, Status usw.) | N/A | 289 | | Ungültig `orderby` (unterstützt: asc, desc) | N/A | 290 | | Ungültiger `offset` Wert | 138 | 138 | | Ungültiger `limit` Wert | 137 | 137 | ## Hinweise – Ab V13 ist diese API für alle Benutzer geöffnet (zuvor auf Systemadministratoren beschränkt). - Ab V18 gibt das `userregistered2FA` Feld an, ob ein Benutzer sich für 2FA registriert hat. --- Diese Beschreibung folgt der Schemaformatierung Swagger 2.0 und sollte im Beschreibungsfeld im Benutzerdefinierten Connector-Schema platziert werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Version der API.
Benutzerstatus	status		string	Filtert Benutzer nach Status: Aktiv, archiviert, inaktiv oder gesperrt.
Paginierungsoffset	offset		string	Startposition für Paginierung.
Ergebnisgrenzwert	limit		string	Anzahl der Elemente, die pro Anforderung zurückgegeben werden sollen.
Organisations-ID	orgid		string	Filtert Benutzer nach Organisations-ID.
Nie eingeladene Benutzer	neverinvited		string	Rufen Sie Benutzer ab, die noch nie eingeladen wurden.
Nie angemeldete Benutzer	neverlogin		string	Rufen Sie Benutzer ab, die sich noch nie angemeldet haben.
Benutzer-ID	userid		string	Filtern sie Benutzer nach ihren eindeutigen Benutzer-IDs.
Gruppen-ID	groupid		string	Filtern sie Benutzer nach Gruppen-ID(n).
Benutzer nicht in Gruppen	notingroup		string	Dient zum Abrufen von Benutzern, die sich nicht in einer Gruppe befinden.
Sortierreihenfolgetyp	ordertype		string	Sortieren Sie Benutzer nach einem angegebenen Feld, z. B. Name, Organisation oder Status.
Sortierreihenfolge	orderby		string	Sortierungsergebnisse in aufsteigender oder absteigender Reihenfolge.
Externe ID	externalid		string	Filtert Benutzer nach externer ID.
Vorname	firstname		string	Filtert Benutzer nach Vornamen.
Nachname	lastname		string	Filtert Benutzer nach Nachnamen.
E-Mail-Adresse	email		string	Filtert Benutzer nach E-Mail-Adresse.
Benutzersuche	search		string	Suchen Sie nach Benutzern nach verschiedenen Attributen, einschließlich Name, E-Mail und Position.
Alphabetfilter	alphabets		string	Filtert Benutzer, deren Nachname mit einem bestimmten Buchstaben beginnt.
Position	jobtitle		string	Filtert Benutzer nach Position.
Standort	locations		string	Filtert Benutzer nach Ort.
Abteilung	departments		string	Filtern Sie Benutzer nach Abteilung.
Name der Organisation	organisations		string	Filtert Benutzer nach Organisationsname.
Spezialitäten	specialities		string	Filtern Sie Benutzer nach ihren Besonderheiten.
Systemadministratorsuche	systemAdminSearch		string	Abrufen von Benutzern mit der Rolle "Systemadministrator".

Gibt zurück

Body: users

Dokumente verschieben

Vorgangs-ID:: moveDocuments

Diese API verschiebt mehrere Dateien von einem Ordner in einen anderen innerhalb derselben Website.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Gibt die API-Version an.
Zielordner-ID	targetfolder	True	string	Der eindeutige Bezeichner des Zielordners, in den die Dateien verschoben werden.
fileidCSV	fileidCSV		string	Die durch Trennzeichen getrennte Liste der zu verschiebenden Datei-IDs.

Hinzufügen einer vorhandenen Gruppe zur Website

Vorgangs-ID:: addExistingGroupToSite

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Ausgabe
Die ID der Website	siteid	True	string	Die ID der Website.
Die ID der Systemgruppe	groupid	True	string	Die ID der Systemgruppe, die der Website hinzugefügt werden soll.

Gibt zurück

Body: sitegroup

Hochladen einer Datei

Vorgangs-ID:: insertDocument

Dieser API-Aufruf lädt eine Datei in einen angegebenen Ordner auf der HighQ-Zusammenarbeitsplattform hoch. Es unterstützt blockierte Uploads, wenn der Inhaltsbereichsheader bereitgestellt wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Gibt die Verwendete API-Version an.
Datei zum Hochladen	file	True	file	Gibt die Datei an, die hochgeladen werden soll.
Übergeordneter Ordner-ID	parentfolderid	True	string	Gibt die eindeutige ID des übergeordneten Ordners an, in den die Datei hochgeladen wird.
Doppelte Kennzeichnung außer Kraft setzen	overrideduplicate		boolean	Gibt an, ob doppelte Dateiuploads überschrieben werden sollen.
Dokumentname	filename	True	string	Gibt den Namen des Dokuments an.
Versionshinweis	versionnote		string	Enthält eine Notiz, die die Version der Datei beschreibt.
Progressive Operation Key	progressiveoperkey		string	Gibt den Schlüssel an, der während des Dateiuploads für progressive Vorgänge verwendet wird.
DMS-Datenbankname	dmsdatabasename		string	Gibt den Namen der Dokumentverwaltungssystem-Datenbank an.
DMS-Bearbeitungsdatum	dmseditdate		string	Gibt das im Dokumentverwaltungssystem aufgezeichnete Bearbeitungsdatum an.
ID des übergeordneten DMS-Ordners	dmsparentfolderid		string	Gibt die eindeutige ID des übergeordneten Ordners im Dokumentverwaltungssystem an.
DMS-Dokument-ID	dmsdocid		string	Gibt die eindeutige ID des Dokuments im Dokumentverwaltungssystem an.
DMS-Dokumentversion	dmsversion		string	Gibt die Im Dokumentverwaltungssystem aufgezeichnete Version des Dokuments an.
Benachrichtigungsdetails	notification		string	Enthält Details zu allen Benachrichtigungen, die beim Hochladen der Datei gesendet werden sollen.
Batch-ID	batchid		string	Gibt die eindeutige ID des Batchvorgangs an.
Stammordner-ID	rootfolderid		string	Gibt die eindeutige ID des Stammordners an.

Ordner erstellen

Vorgangs-ID:: addFolder

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Gibt die API-Version an.
Batchbezeichner	batchid		string	Ein eindeutiger Bezeichner für den Batchvorgang.
Stammordner-ID	rootfolderid		string	Der eindeutige Bezeichner des Stammordners.
Übergeordneter Ordner-ID	parentfolderid	True	string	Der eindeutige Bezeichner des übergeordneten Ordners, in dem der neue Ordner erstellt wird.
Duplikatordner zulassen	allowduplicatefolder		boolean	Gibt an, ob doppelte Ordner im angegebenen übergeordneten Ordner zulässig sind.
name	name	True	string	Der Name des Ordners.
Beschreibung	description		string	Eine Beschreibung des Ordners.
accessInherited	accessInherited		integer	Gibt an, ob der Ordnerzugriff geerbt wird.
batchID	batchID		string	Der Batchbezeichner für den Vorgang.
dmsfolderid	dmsfolderid		string	Der DMS-Ordnerbezeichner.
dmsParentFolderID	dmsParentFolderID		string	Der BEzeichner des übergeordneten DMS-Ordners.
dmscreateddate	dmscreateddate		date-time	Das Datum, an dem der DMS-Ordner erstellt wurde.
dmsmodifiedBy	dmsmodifiedBy		string	Der Benutzer, der den DMS-Ordner zuletzt geändert hat.
dmsdatabasename	dmsdatabasename		string	Der Name der DMS-Datenbank.
dmslink	dmslink		boolean	Gibt an, ob ein DMS-Link verfügbar ist.
dmslinkby	dmslinkby		string	Der Benutzer, der den DMS-Ordner verknüpft hat.
emailmetadata	emailmetadata		string	Dem Ordner zugeordnete E-Mail-Metadaten.

Gibt zurück

Body: FolderDBOV1

So erstellen Sie das iSheet-Element

Vorgangs-ID:: insertISheetItems

Dieser API-Aufruf wird verwendet, um iSheet-Element einzufügen. Mehrere iSheets können unterstützt werden.

Rufen Sie DIE API POST /api/3/progressivekeystatus/{progressive_key} auf, um den Status eines iSheet-Elements basierend auf einem progressiven Schlüssel abzurufen.

z. B. POST /api/{version}/progressivekeystatus/{progressive_key}

Name	Typ	Description
progressive_key	String	Schlüssel zum Überprüfen des Status Ihrer Aktion.

Antwort


              
              <progressiveKeyresponse>

               \t<Elemente>

                \t\t<Element>

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

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

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

                 \t\t\t<Nachrichtendatensatz>wurde erfolgreich</nachricht hinzugefügt>

                \t\t</item>

                \t\t<Element>

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

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

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

                 \t\t\t<Nachrichtendatensatz>wurde erfolgreich</nachricht hinzugefügt>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Version der API
iSheet-Id	isheetid	True	integer	ID des iSheet
Blattansichtsbezeichner	sheetviewid		integer	ID der iSheet-Ansicht (Optional)
id	id		integer	Isheet-ID.
title	title		string	Titel des Blatts.
Beschreibung	description		string	Beschreibung des Blatts.
status	status		string	Status des Blatts.
Accesstype	accesstype		string	Access-Typ des Blatts.
type	type		string	Typ des Blatts.
viewlink	viewlink		string	URL-Link zum Anzeigen des Blatts.
allowsections	allowsections		string	Gibt an, ob Abschnitte zulässig sind.
allowlookup	allowlookup		string	Gibt an, ob nachschlagen zulässig ist.
displayisheet	displayisheet		string	isheet anzeigen.
searchasdefaultview	searchasdefaultview		string	Legt die Suche als Standardansicht fest.
enableversion	enableversion		string	Version aktivieren.
enablesheetalerter	enablesheetalerter		string	Aktiviert die Blattbenachrichtigung.
alertercondition	alertercondition		string	Bedingung zum Auslösen von Warnungen.
overrideitemmodifieddate	overrideitemmodifieddate		string	Über fahrt das Änderungsdatum des Elements.
enablebulkinsertupdate	enablebulkinsertupdate		string	Masseneinfügungsaktualisierung zulassen.
FieldDescriptions	fielddescriptions		string	Beschreibung für Felder.
enablerowlocking	enablerowlocking		string	Aktiviert die Zeilensperre.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Aktiviert das Abschneiden von Zeichen für mehrzeilen Text.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	legt den Zeichengrenzwert für den Abschneiden fest.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Ermöglicht die Wiederverwendung von Auswahllistenwerten.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Ermöglicht die Wiederverwendung von Bewertungslistenwerten.
allowIsheetComments	allowIsheetComments		string	Erlaubt Kommentare auf dem Blatt.
shareRecordsLimit	shareRecordsLimit		integer	Grenzwert für freigegebene Datensätze.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Freigabedatensatzlimit aktivieren.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Ermöglicht die Freigabe des Formulars zum Hinzufügen eines Datensatzes.
allowViewBaseRendering	allowViewBaseRendering		string	Ermöglicht das Basisrendering von Ansichten.
Spalte	column		object
Recordcount	recordcount		string	Gesamtzahl der Datensätze.
viewId	viewId		integer	Eindeutiger Bezeichner für die Ansicht.
siteId	siteId		integer	Bezeichner für die zugeordnete Website.
siteName (englisch)	siteName		string	Name der Website.
sheetName	sheetName		string	Name des Blatts.
viewName	viewName		string	Name der Ansicht.
sheetId	sheetId		integer	Bezeichner für das Blatt.
Sequenz	sequence		string	Sequenznummer der Kopfzeilenspalte.
columnValue	columnValue		string	Wert der Kopfzeilenspalte.
columnTypeId	columnTypeId		string	Bezeichner für den Spaltentyp.
columnId	columnId		string	Eindeutiger Bezeichner für die Spalte.
columnTypeAlias	columnTypeAlias		string	Aliasname für den Spaltentyp.
itemsequence	itemsequence		string	Sequenznummer des Elements.
itemid	itemid		string	Eindeutiger Bezeichner für das Element.
externalid	externalid		string	Externer Bezeichner, der dem Element zugeordnet ist.
columnid	columnid		integer	Eindeutiger Bezeichner für die Spalte
name	name		string	Name der Spalte
type	type		integer	Datentyp der Spalte.
systemgeneratedtype	systemgeneratedtype		string	Vom System generierte Typinformationen.
section	section		integer	Abschnittsnummer, in der sich die Spalte befindet.
Beschreibung	description		string	Detaillierte Beschreibung der Spalte.
addtodefaultview	addtodefaultview		string	Gibt an, ob die Spalte der Standardansicht hinzugefügt wird.
columnconditionstate	columnconditionstate		string	Zustand der Bedingung der Spalte.
rowid	rowid		integer	Bezeichner für die Zeile.
columnid	columnid		integer	Bezeichner für die Spalte.
operatorid	operatorid		integer	Bezeichner für den Operator.
oprand	oprand		string	Operandwert für den Filter.
Logischer Typ	logicaltype		string	Logischer Typ des Filters.
sheetfiltervaluetypeid	sheetfiltervaluetypeid		string	ID für den Blattfilterwerttyp.
Anzeigetyp	displaytype		string	Anzeigetyp des Filters.
sourceColumnId	sourceColumnId		integer	Quellspalten-ID für den Filter.
scoreConditionTypeid	scoreConditionTypeid		integer	ID für den Scorebedingungstyp.
Standardwert	defaultvalue		string	Standardwert für die Spalte.
Columnwidth	columnwidth		string	Breite der Spalte.
Blattname	sheetname		string	Name des zugeordneten Blatts.
Websitename	sitename		string	Name der Website.
obligatorisch	mandatory		string	Gibt an, ob die Spalte obligatorisch ist.
allowsearch	allowsearch		string	Gibt an, ob die Suche zulässig ist.
Maxchars	maxchars		integer	Maximale Anzahl von Zeichen.
allowfieldfromanotherisheet	allowfieldfromanotherisheet		string	Ermöglicht das Feld aus einem anderen Blatt.
allowrichhtmltext	allowrichhtmltext		string	Gibt an, ob Rich-HTML-Text zulässig ist.
numberoflines	numberoflines		integer	Anzahl der Zeilen in der Spalte.
displaymethod	displaymethod		string	Methode, die zum Anzeigen der Spalte verwendet wird.
includeotheroption	includeotheroption		string	Enthält eine Option "Sonstige".
singleormultileselectioninsearch	singleormultileselectioninsearch		string	Gibt den Auswahltyp in der Suche an.
id	id		string	Eindeutiger Bezeichner für die Auswahl."
label	label		string	Beschriftung für die Auswahl.
score	score		string	Der Auswahl zugeordnete Score.
color	color		string	Farbcode für die Auswahl.
Imageid	imageid		integer	ID des zugeordneten Bilds.
includeinalertpreferences	includeinalertpreferences		string	Enthält in Benachrichtigungseinstellungen.
min	min		string	Minimalwert für die Spalte.
max	max		string	Maximalwert für die Spalte.
Dezimalstellen	decimalplaces		integer	Anzahl der Dezimalstellen.
showthousandseparators	showthousandseparators		string	Zeigt Tausendertrennzeichen an.
showaspercentage	showaspercentage		string	Zeigt den Wert als Prozentsatz an.
Formattyp	formattype		string	Gibt den Formattyp der Spalte an.
dateformat	dateformat		string	Definiert das Datumsformat für die Spalte.
defaultdateandtime	defaultdateandtime		string	Legt den Standarddatums- und Uhrzeitwert für die Spalte fest.
Sheetlookup	sheetlookup		string	Gibt an, ob es sich bei der Spalte um einen Nachschlagevorgang in einem anderen Blatt handelt.
fielddisplay	fielddisplay		string	Bestimmt, wie das Feld angezeigt wird.
allowmultipleusers	allowmultipleusers		string	Gibt an, ob mehrere Benutzer auf das Feld zugreifen können.
methodtype	methodtype		string	Definiert den Methodentyp für die Spalte.
Sheetids	sheetids		string	Listet die IDs der Blätter auf, die der Spalte zugeordnet sind.
allowuserstorenamelinks	allowuserstorenamelinks		string	Gibt an, ob Benutzer Links in der Spalte umbenennen können.
sheetid	sheetid		integer	Gibt die ID des Blatts an.
columnids	columnids		string	Listet die IDs der Spalten auf.
viewid	viewid		integer	Gibt die ID der Ansicht an.
allowmultiplevalues	allowmultiplevalues		string	Gibt an, ob in der Spalte mehrere Werte zulässig sind.
restrictDelete	restrictdelete		string	Gibt an, ob der Löschvorgang für die Spalte eingeschränkt ist.
displaycolumnnameprefix	displaycolumnnameprefix		string	Legt das Präfix für die Anzeige des Spaltennamens fest.
Linkname	linkname		string	Definiert den Namen des Links, der der Spalte zugeordnet ist.
donotcountweekendsonlycountmontofri	donotcountweekendsonlycountmontofri		string	Gibt an, ob Wochenenden bei der Zählung ausgeschlossen werden.
currentsheetcolumnid	currentsheetcolumnid		integer	ID der aktuellen Blattspalte.
targetsheetcolumnid	targetsheetcolumnid		integer	ID der Zielblattspalte.
Formel	formula		string	Gibt die Formel an, die auf die Spalte angewendet wird.
startvalue	startvalue		integer	Legt den Startwert für die Spalte fest.
prefix	prefix		string	Definiert das Präfix für die Spaltenwerte.
Postfix	postfix		string	Definiert das Postfix für die Spaltenwerte.
Minlength	minlength		integer	Gibt die Mindestlänge der Spaltenwerte an.
Lookupglossarysheetid	lookupglossarysheetid		integer	Gibt die ID des Nachschlagewörterblatts an.
Lookupglossarysheetviewid	lookupglossarysheetviewid		integer	Gibt die Ansichts-ID des Nachschlagewörterblatts an.
width	width		integer	Legt die Breite der Spalte fest.
otherscorevalue	otherscorevalue		string	Definiert den anderen Bewertungswert für die Spalte.
importdatafromexternalsource	importdatafromexternalsource		string	Gibt an, ob Daten aus einer externen Quelle importiert werden.
analysisengine	analysisengine		string	Gibt das Analysemodul an, das für die Spalte verwendet wird.
attachmentcustomfolderid	attachmentcustomfolderid		integer	Gibt die benutzerdefinierte Ordner-ID für Anlagen an.
isattachmentfoldercurrentsite	isattachmentfoldercurrentsite		integer	Gibt an, ob sich der Anlagenordner auf der aktuellen Website befindet.
singleLineEmailValidation	singleLineEmailValidation		string	Gibt an, ob eine einzeilige E-Mail-Überprüfung angewendet wird.
readonly	readonly		string	Gibt an, ob die Spalte schreibgeschützt ist.
virtualColumn	virtualColumn		integer	Gibt an, ob die Spalte virtuell ist.
allowInlineEditing	allowInlineEditing		string	Gibt an, ob die Inlinebearbeitung für die Spalte zulässig ist.
Sequenz	sequence		string	Sequenznummer der Spalte.
attributecolumnid	attributecolumnid		string	Attributspaltenbezeichner.
value	value		string	Wert von Rohdaten.
date	date		string	Datum der Rohdaten.
time	time		string	Zeit der Rohdaten.
linkdisplayname	linkdisplayname		string	Anzeigelinkname.
linkdisplayurl	linkdisplayurl		string	URL-Link anzeigen.
id	id		string	Nachschlage-ID
E-Mail	email		string	E-Mail-Adresse.
userlookuptype	userlookuptype		string	Benutzer-Nachschlagetyp.
folderid	folderid		string	Ordner-ID.
docid	docid		string	Dokument-ID.
fromdate	fromdate		string	Ab Datum.
Bis zum Datum	todate		string	Bis heute.
file	file		string	Der Dateiinhalt.
name	name		string	Der Name der Anlage.
order	order		string	Die Reihenfolge der Anlage.
id	id		integer	Eindeutiger Bezeichner für die Anlage.
Erweiterung	extension		string	Dateiendung.
parentfolderid	parentfolderid		integer	ID des übergeordneten Ordners.
filehttplink	filehttplink		string	HTTP-Link für den Zugriff auf die Datei.
folderpath	folderpath		string	Pfad zum Ordner, der die Datei enthält.
folderhttplink	folderhttplink		string	HTTP-Link zum Ordner.
filesize	filesize		integer	Größe der Datei in Byte.
redactionStatus	redactionStatus		boolean	Gibt an, ob die Datei redacted ist.
displayname	displayname		string	Anzeigename der Anlage.
siteid	siteid		integer	ID der Website, die der Anlage zugeordnet ist.
Datensatz-ID	recordid		string	Datensatz-ID.
Linkname	linkname		string	Linkname.
apilink	apilink		string	API-Link.
httplink	httplink		string	HTTP-Link.
colViewPosition	colViewPosition		integer	Position der Spalte in der Ansicht.
Columntype	columntype		string	Typ der Spalte.
Erstellungsdatum	createdDate		date-time	Datum und Uhrzeit der Erstellung der Spalte.
modifiedDate	modifiedDate		date-time	Datum und Uhrzeit der letzten Änderung der Spalte.
injectReferenceColumn	injectReferenceColumn		integer	Verweis auf eine eingefügte Spalte
parentColumnID	parentColumnID		integer	Bezeichner der übergeordneten Spalte.
reusecolumnidfromisheet	reusecolumnidfromisheet		integer	Spalten-ID, die aus einem Eingabeblatt wiederverwendet wird.
choicelistid	choicelistid		integer	Bezeichner für die Auswahlliste, die der Spalte zugeordnet ist.
alerteroption	alerteroption		string	Benachrichtigungsoptionseinstellung für das Element.
sheettypeid	sheettypeid		integer	Bezeichner für den Blatttyp.
enableSmartForm	enableSmartForm		string	Aktiviert smarte Formularfeatures.
allowDeletedItemsView	allowDeletedItemsView		string	Ermöglicht das Anzeigen von gelöschten Elementen.
allowAllColumnsInCustomView	allowAllColumnsInCustomView		string	Erlaubt alle Spalten in benutzerdefinierten Ansichten.

Gibt zurück

Body: ProgressiveKeyDBO

Website aktualisieren

Vorgangs-ID:: updateSite

Verwenden Sie diesen API-Endpunkt, um die Details einer vorhandenen Website zu aktualisieren. Die API unterstützt dieselben Felder, die in der Create Site API verwendet werden.

Diese Methode unterstützt mehrere Materienummern, die mit API Version 10 zur Website hinzugefügt werden. "matternos"-Tag gibt mehrere Materienummern mit schreibgeschützter Schreibweise an.

Jetzt kann der Websitebesitzer auch anderen Benutzern zugewiesen werden, aber sie müssen Websiteteilnehmer sein und eine Rolle höher als der Websiteadministrator haben.

Version 18 weiter: Der Websitebesitzer kann der Website andere Benutzer zur Website hinzufügen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Die Version der angeforderten API	version	True	string	Version der API
Der eindeutige Bezeichner für die Website	siteid	True	string	Die ID für die Website
id	id		integer	Der Websitebezeichner.
Websitename	sitename		string	Der Name der Website.
role	role		string	Die Rolle der Website.
sitedescription	sitedescription		string	Die Beschreibung der Website.
enabledmodules	enabledmodules		string	Eine Liste der module, die für die Website aktiviert sind.
sitefolderID	sitefolderID		string	Der Bezeichner für den Ordner der Website.
sitefolderpermission	sitefolderpermission		string	Die Berechtigungsstufe für den Ordner der Website.
ermöglichen	enable		string	Status für HomeDBO aktivieren.
ermöglichen	enable		string	Status für ActivityDBO aktivieren.
Mikroblog	microblog		string	Mikrobloginhalte, die mit ActivityDBO verknüpft sind.
docid	docid		string	Dokument-ID.
blogTitle	blogTitle		string	Titel des Blogbeitrags.
blogContent	blogContent		string	Inhalt des Blogbeitrags.
showComment	showComment		integer	den Kommentar anzeigen.
tagListe	tagList		array of string	Liste der Tags, die dem Blog zugeordnet sind.
status	status		integer	Status des Blogbeitrags.
siteID	siteID		integer	Bezeichner für die zugeordnete Website.
Autor	author		string	Autor des Blogs.
categoryList	categoryList		array of string	Kategorien, die dem Blogbeitrag zugewiesen sind.
notificationTypeID	notificationTypeID		integer	Bezeichner für den Benachrichtigungstyp.
message	message		string	Nachrichteninhalte im Zusammenhang mit dem Blog.
messageCode	messageCode		integer	Code, der der Nachricht zugeordnet ist.
externalID	externalID		string	Externer Bezeichner, der mit dem Blog verknüpft ist.
publishDatum	publishDate		string	Veröffentlichungsdatum des Blogs.
Prozesstyp	processtype		string	Prozesstyp, der dem Blog zugeordnet ist.
ermöglichen	enable		string	Status für BlogDBO aktivieren.
wikiid	wikiid		integer	Eindeutiger Bezeichner für das Wiki.
currentversionid	currentversionid		integer	Bezeichner für die aktuelle Version des Wikis
parentwikiid	parentwikiid		integer	Bezeichner für das übergeordnete Wiki.
Wikititle	wikititle		string	Der Titel des Wikis.
Wikicontent	wikicontent		string	Inhalt des Wikis.
Kommentar anzeigen	showcomment		integer	Gibt an, ob Kommentare aktiviert sind.
createddate	createddate		string	Erstellungsdatum des Wikis.
modifieddate	modifieddate		string	Datum der letzten Änderung des Wikis.
Tagliste	taglist		string	Durch Trennzeichen getrennte Liste von Tags, die dem Wiki zugeordnet sind.
Wikipath	wikipath		string	Pfad für den Zugriff auf das Wiki.
wikidraftid	wikidraftid		integer	Bezeichner für die Entwurfsversion des Wikis.
Entwurfstyp	drafttype		string	Typ des Entwurfs, der dem Wiki zugeordnet ist.
status	status		integer	Aktueller Status des Wikis.
wikiversionid	wikiversionid		integer	Versionsbezeichner des Wikis.
index	index		string	Index oder Bezeichner für die Aufgabe.
parenttaskid	parenttaskid		integer	Bezeichner für die übergeordnete Aufgabe.
taskid	taskid		integer	Eindeutiger Bezeichner des Vorgangs.
title	title		string	Titel des Vorgangs.
Beschreibung	description		string	Detaillierte Beschreibung des Vorgangs.
Fälligkeitsdatum	duedate		string	Fälligkeitsdatum für den Vorgangsabschluss.
Startdatum	startdate		string	Startdatum, an dem die Aufgabe initiiert wurde.
mattermaptaskid	mattermaptaskid		string	Bezeichnerverknüpfung mit dem Vorgang "Matter Map".
type	type		string	Typ oder Kategorie des Vorgangs.
dependenton	dependenton		string	Aufgaben, von denen dieser Vorgang abhängt.
daysfromdependent	daysfromdependent		string	Anzahl der Tage ab dem abhängigen Vorgang.
ignoreweekend	ignoreweekend		integer	Gibt an, ob Wochenenden in der Planung ignoriert werden.
duration	duration		integer	Dauer, um den Vorgang abzuschließen.
resource	resource		string	Dem Vorgang zugeordnete Ressourcen.
eventTitle	eventTitle		string	Titel des Ereignisses.
eventContent	eventContent		string	Inhalt des Ereignisses.
showComment	showComment		integer	Gibt an, ob Kommentare für das Ereignis aktiviert sind.
tagListe	tagList		array of string	Liste der Tags, die dem Ereignis zugeordnet sind.
status	status		integer	Aktueller Status des Ereignisses.
siteID	siteID		integer	Bezeichner für die Website.
Kontakt	contact		string	Kontaktinformationen für das Ereignis.
categoryList	categoryList		array of string	Kategorien, unter denen das Ereignis aufgeführt wird.
notificationTypeID	notificationTypeID		integer	Der Benachrichtigungstyp im Zusammenhang mit dem Ereignis.
message	message		string	Die Meldung des Ereignisses.
messageCode	messageCode		integer	Der Nachrichtencode des Ereignisses.
externalID	externalID		string	Der externe Bezeichner.
startDate	startDate		string	Das Startdatum des Ereignisses.
Enddatum	endDate		string	Das Enddatum des Ereignisses.
startTime	startTime		string	Die Startzeit des Ereignisses.
endTime	endTime		string	Die Endzeit des Ereignisses.
location	location		string	Der Ort des Ereignisses.
Autor	author		string	Der Autor des Ereignisses.
Prozesstyp	processtype		string	Die Prozesszeit des Ereignisses.
ermöglichen	enable		string	Enable's the event.
id	id		integer	Eindeutiger Bezeichner für das iSheet.
title	title		string	Titel des iSheet.
Beschreibung	description		string	Beschreibung des isheets.
status	status		string	Status des isheets.
Accesstype	accesstype		string	Access-Typ des isheets.
type	type		string	Typ des isheets.
viewlink	viewlink		string	Link zum Anzeigen des iSheets.
allowsections	allowsections		string	Gibt an, ob Abschnitte zulässig sind.
allowlookup	allowlookup		string	Gibt an, ob Nachschlagefelder aktiviert sind.
displayisheet	displayisheet		string	Anzeigeoptionen für das iSheet.
searchasdefaultview	searchasdefaultview		string	Gibt an, ob die Suche die Standardansicht ist.
enableversion	enableversion		string	Versionsverwaltung aktiviertes Flag.
enablesheetalerter	enablesheetalerter		string	Kennzeichnen, um Blattwarnungen zu aktivieren.
alertercondition	alertercondition		string	Bedingungen zum Auslösen von Warnungen.
overrideitemmodifieddate	overrideitemmodifieddate		string	Änderungsdatumskennzeichnung außer Kraft setzen.
enablebulkinsertupdate	enablebulkinsertupdate		string	Masseneinfügung/Aktualisierung aktivieren.
FieldDescriptions	fielddescriptions		string	Feldbeschreibungen für das iSheet.
enablerowlocking	enablerowlocking		string	Aktivieren Sie die Sperrung auf Zeilenebene.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Mehrfachzeilentextkennzeichnung abschneiden.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Zeichenlimit für mehrteilige Abkürzung.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Wiederverwendung von Auswahllistenwerten zulassen.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Wiederverwendung von Bewertungslistenwerten zulassen.
allowIsheetComments	allowIsheetComments		string	Kommentare in iSheet zulassen.
shareRecordsLimit	shareRecordsLimit		integer	Grenzwert für Datensätze, die freigegeben werden dürfen.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Grenzwert für aktivierte Datensatzfreigaben.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Aktivieren sie die Formularfreigabe zum Hinzufügen von Datensätzen.
Recordcount	recordcount		string	Aktuelle Datensatzanzahl.
sheettypeid	sheettypeid		integer	Typ-ID des iSheet
ermöglichen	enable		string	Aktivieren Sie die QA-Funktion.
userid	userid		integer	Benutzer-ID.
E-Mail	email		string	E-Mail-Adresse.
httpavatar	httpavatar		string	HTTP-URL des Avatars.
Avatar	avatar		string	Avatarbild.
userlink	userlink		string	Link zu Benutzerprofilen.
httplink	httplink		string	HTTP-Link zum Benutzerprofil.
phone	phone		string	Telefonnummer.
mobile	mobile		string	Handynummer.
Abteilung	department		string	Abteilung des Benutzers.
ermöglichen	enable		string	Aktivieren der Vertrags express-Integration.
adminnote	adminnote		string	Administrative Notizen im Zusammenhang mit der Website.
Startdatum	startdate		string	Das Startdatum des Websitevorgangs.
Enddatum	enddate		string	Das Enddatum des Vorgangs der Website.
createddate	createddate		string	Das Datum, an dem die Website erstellt wurde.
archiviertes Datum	archiveddate		string	Das Datum, an dem die Website archiviert wurde.
clientno	clientno		string	Die Clientnummer, die der Website zugeordnet ist.
matterno	matterno		string	Die mit der Website verknüpfte Nummer der Angelegenheit.
Landingpage	landingpage		string	Die URL der Zielseite für die Website.
link	link		string	Ein Link im Zusammenhang mit der Website.
status	status		string	Der aktuelle Status der Website.
statusid	statusid		integer	Der Bezeichner für den Status der Website.
size	size		string	Die Größe der Website.
Abrechnungsnoten	billingnotes		string	Hinweise zur Abrechnung für die Website.
billingnextinvoicedate	billingnextinvoicedate		string	Das Datum der nächsten Rechnung für die Website.
billinglastinvoicedate	billinglastinvoicedate		string	Das Datum der letzten Rechnung für die Website.
filepagecount	filepagecount		string	Die Gesamtzahl der Seitenanzahl von Dateien auf der Website.
maxpagecount	maxpagecount		string	Die maximal zulässige Seitenanzahl für Dateien auf der Website.
sitehttplink	sitehttplink		string	Der HTTP-Link zur Website.
isSyncable	isSyncable		integer	Gibt an, ob die Website synchronisiert werden kann.
enforceusergroups	enforceusergroups		string	Die für die Website erzwungenen Benutzergruppen.
csvSiteCategory	csvSiteCategory		string	Die Kategorie der Website im CSV-Format.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Der Name der Website in der Standardsprache.
sichtbar	visible		integer	Gibt an, ob die Website sichtbar ist.
siteLogoName	siteLogoName		string	Der Name der Logodatei der Website.
siteLogoFileSize	siteLogoFileSize		integer	Die Dateigröße des Websitelogos.
siteLogoHeight	siteLogoHeight		integer	Die Höhe des Websitelogos.
siteLogoWidth	siteLogoWidth		integer	Die Breite des Websitelogos.
siteStatus	siteStatus		integer	Der Statuscode der Website.
applySiteTerms	applySiteTerms		integer	Gibt an, ob Websitebegriffe angewendet werden.
siteTerm	siteTerm		string	Die Bedingungen, die auf die Website angewendet werden.
termType	termType		integer	Der Auf die Website angewendete Ausdruckstyp.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Gibt an, ob Websitebedingungen bei der nächsten Anmeldung erforderlich sind.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Gibt an, ob Standardwebsitebegriffe aktiviert sind.
advancedQAPermission	advancedQAPermission		integer	Die erweiterte QA-Berechtigungsstufe für die Website.
isIntern	isInternal		integer	Gibt an, ob die Website intern ist.
Psm	psm		integer	Der Product Service Manager-Bezeichner.
siteLabelDisplay	siteLabelDisplay		string	Die Anzeigebezeichnung für die Website.
allowSiteAdministration	allowSiteAdministration		integer	Gibt an, ob die Websiteverwaltung zulässig ist.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	So aktivieren Sie den Kennwortschutz auf Websiteebene.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	So aktivieren Sie den Kennungsschutz auf Websiteebene.
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Gibt an, ob die Kenncodeauthentifizierung eine Authentifizierungs-App verwendet.
sitePassword	sitePassword		string	Das Kennwort, das der Website zugeordnet ist.
ipRestrictionEnable	ipRestrictionEnable		integer	So aktivieren Sie IP-Einschränkungen für den Websitezugriff.
availableIP	availableIP		string	Durch Trennzeichen getrennte Liste der IP-Adressen, die für den Zugriff auf die Website zulässig sind.
highqDrive	highqDrive		integer	Gibt an, ob die HighQ Drive-Integration aktiviert ist.
applySiteHomePage	applySiteHomePage		integer	So wenden Sie eine benutzerdefinierte Startseite für die Website an.
siteHomePage	siteHomePage		string	URL der benutzerdefinierten Homepage für die Website.
siteHomePageType	siteHomePageType		integer	Typ der Startseite.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	So legen Sie die nächste Anmeldung auf der Homepage der Website fest.
applyDisplayContent	applyDisplayContent		integer	So wenden Sie Anzeigeinhaltseinstellungen an.
displayContent	displayContent		string	Inhalt, der auf der Website angezeigt werden soll.
rssSecurity	rssSecurity		integer	Sicherheitsstufe für RSS-Feed.
encryptedPassword	encryptedPassword		integer	Gibt an, ob das Websitekennwort verschlüsselt ist.
availableIPRangeCSV	availableIPRangeCSV		string	Durch Trennzeichen getrennte Liste der IP-Adressbereiche, die für den Zugriff auf die Website zulässig sind.
siteModuleID	siteModuleID		integer	Bezeichner für das Websitemodul.
icalSecurity	icalSecurity		integer	iCal-Feed-Sicherheitsstufe.
defaultDisplayContent	defaultDisplayContent		string	Standardinhalt, der auf der Website angezeigt werden soll.
defaultEmailAlert	defaultEmailAlert		integer	So aktivieren Sie standardmäßige E-Mail-Benachrichtigungen.
excelReportFooter	excelReportFooter		integer	Enthält eine Fußzeile in Excel-Berichten.
excelReportFooterText	excelReportFooterText		string	Text, der in der Fußzeile von Excel-Berichten angezeigt werden soll.
announcementMLJSON	announcementMLJSON		string	JSON-formatierte Ankündigungen für die Website.
templateType	templateType		integer	Typ der Vorlage, die für die Website verwendet wird.
templateLicence	templateLicence		integer	Lizenztyp für die Websitevorlage.
openChannelAppID	openChannelAppID		string	Anwendungs-ID für die Integration des geöffneten Kanals.
itemid	itemid		integer	Bezeichner für das Element, das der Website zugeordnet ist.
sitemetadatasheetid	sitemetadatasheetid		integer	ID des Metadatenblatts, das der Website zugeordnet ist.
meine Website	mysite		boolean	Gibt an, ob dies die persönliche Website des Benutzers ist.
lastaccesseddate	lastaccesseddate		string	Datum und Uhrzeit des letzten Zugriffs auf die Website.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Standardmetadatenregisterkarte für den Website-Viewer.
documentMetadataViewId	documentMetadataViewId		integer	Dokumentmetadaten für ansichtsbezeichner.
folderMetadataViewId	folderMetadataViewId		integer	Ordnermetadaten für ansichtsbezeichner.
docSort	docSort		integer	Die Sortierreihenfolge von Dokumenten.
folderSort	folderSort		integer	Die Sortierreihenfolge von Ordnern.
defaultFolderRenderView	defaultFolderRenderView		integer	Bestimmt den Standardansichtsmodus für Ordner.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Der Standardspeicherort für Aufgabenanlagen.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Der eindeutige Bezeichner des Ordners, der als Standardspeicherort für Aufgabenanlagen festgelegt ist.
Favorit	favourite		string	Lieblingsstatus.
enabledocumentredaction	enabledocumentredaction		boolean	Gibt an, ob die Dokument redaction für die Website aktiviert ist.
Erwähnungsgruppen	mentiongroups		integer	Die genannten Gruppen.
enablefilerelationships	enablefilerelationships		boolean	Gibt an, ob Dateibeziehungen aktiviert sind.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Die Berechtigungsstufe, die zum Verwalten von Dateibeziehungen erforderlich ist.

Website hinzufügen

Vorgangs-ID:: createSite

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Die Version der angeforderten API	version	True	string	Version der API
id	id		integer	Der Websitebezeichner.
Websitename	sitename		string	Der Name der Website.
role	role		string	Die Rolle der Website.
sitedescription	sitedescription		string	Die Beschreibung der Website.
enabledmodules	enabledmodules		string	Eine Liste der module, die für die Website aktiviert sind.
sitefolderID	sitefolderID		string	Der Bezeichner für den Ordner der Website.
sitefolderpermission	sitefolderpermission		string	Die Berechtigungsstufe für den Ordner der Website.
ermöglichen	enable		string	Status für HomeDBO aktivieren.
ermöglichen	enable		string	Status für ActivityDBO aktivieren.
Mikroblog	microblog		string	Mikrobloginhalte, die mit ActivityDBO verknüpft sind.
docid	docid		string	Dokument-ID.
blogTitle	blogTitle		string	Titel des Blogbeitrags.
blogContent	blogContent		string	Inhalt des Blogbeitrags.
showComment	showComment		integer	den Kommentar anzeigen.
tagListe	tagList		array of string	Liste der Tags, die dem Blog zugeordnet sind.
status	status		integer	Status des Blogbeitrags.
siteID	siteID		integer	Bezeichner für die zugeordnete Website.
Autor	author		string	Autor des Blogs.
categoryList	categoryList		array of string	Kategorien, die dem Blogbeitrag zugewiesen sind.
notificationTypeID	notificationTypeID		integer	Bezeichner für den Benachrichtigungstyp.
message	message		string	Nachrichteninhalte im Zusammenhang mit dem Blog.
messageCode	messageCode		integer	Code, der der Nachricht zugeordnet ist.
externalID	externalID		string	Externer Bezeichner, der mit dem Blog verknüpft ist.
publishDatum	publishDate		string	Veröffentlichungsdatum des Blogs.
Prozesstyp	processtype		string	Prozesstyp, der dem Blog zugeordnet ist.
ermöglichen	enable		string	Status für BlogDBO aktivieren.
wikiid	wikiid		integer	Eindeutiger Bezeichner für das Wiki.
currentversionid	currentversionid		integer	Bezeichner für die aktuelle Version des Wikis
parentwikiid	parentwikiid		integer	Bezeichner für das übergeordnete Wiki.
Wikititle	wikititle		string	Der Titel des Wikis.
Wikicontent	wikicontent		string	Inhalt des Wikis.
Kommentar anzeigen	showcomment		integer	Gibt an, ob Kommentare aktiviert sind.
createddate	createddate		string	Erstellungsdatum des Wikis.
modifieddate	modifieddate		string	Datum der letzten Änderung des Wikis.
Tagliste	taglist		string	Durch Trennzeichen getrennte Liste von Tags, die dem Wiki zugeordnet sind.
Wikipath	wikipath		string	Pfad für den Zugriff auf das Wiki.
wikidraftid	wikidraftid		integer	Bezeichner für die Entwurfsversion des Wikis.
Entwurfstyp	drafttype		string	Typ des Entwurfs, der dem Wiki zugeordnet ist.
status	status		integer	Aktueller Status des Wikis.
wikiversionid	wikiversionid		integer	Versionsbezeichner des Wikis.
index	index		string	Index oder Bezeichner für die Aufgabe.
parenttaskid	parenttaskid		integer	Bezeichner für die übergeordnete Aufgabe.
taskid	taskid		integer	Eindeutiger Bezeichner des Vorgangs.
title	title		string	Titel des Vorgangs.
Beschreibung	description		string	Detaillierte Beschreibung des Vorgangs.
Fälligkeitsdatum	duedate		string	Fälligkeitsdatum für den Vorgangsabschluss.
Startdatum	startdate		string	Startdatum, an dem die Aufgabe initiiert wurde.
mattermaptaskid	mattermaptaskid		string	Bezeichnerverknüpfung mit dem Vorgang "Matter Map".
type	type		string	Typ oder Kategorie des Vorgangs.
dependenton	dependenton		string	Aufgaben, von denen dieser Vorgang abhängt.
daysfromdependent	daysfromdependent		string	Anzahl der Tage ab dem abhängigen Vorgang.
ignoreweekend	ignoreweekend		integer	Gibt an, ob Wochenenden in der Planung ignoriert werden.
duration	duration		integer	Dauer, um den Vorgang abzuschließen.
resource	resource		string	Dem Vorgang zugeordnete Ressourcen.
eventTitle	eventTitle		string	Titel des Ereignisses.
eventContent	eventContent		string	Inhalt des Ereignisses.
showComment	showComment		integer	Gibt an, ob Kommentare für das Ereignis aktiviert sind.
tagListe	tagList		array of string	Liste der Tags, die dem Ereignis zugeordnet sind.
status	status		integer	Aktueller Status des Ereignisses.
siteID	siteID		integer	Bezeichner für die Website.
Kontakt	contact		string	Kontaktinformationen für das Ereignis.
categoryList	categoryList		array of string	Kategorien, unter denen das Ereignis aufgeführt wird.
notificationTypeID	notificationTypeID		integer	Der Benachrichtigungstyp im Zusammenhang mit dem Ereignis.
message	message		string	Die Meldung des Ereignisses.
messageCode	messageCode		integer	Der Nachrichtencode des Ereignisses.
externalID	externalID		string	Der externe Bezeichner.
startDate	startDate		string	Das Startdatum des Ereignisses.
Enddatum	endDate		string	Das Enddatum des Ereignisses.
startTime	startTime		string	Die Startzeit des Ereignisses.
endTime	endTime		string	Die Endzeit des Ereignisses.
location	location		string	Der Ort des Ereignisses.
Autor	author		string	Der Autor des Ereignisses.
Prozesstyp	processtype		string	Die Prozesszeit des Ereignisses.
ermöglichen	enable		string	Enable's the event.
id	id		integer	Eindeutiger Bezeichner für das iSheet.
title	title		string	Titel des iSheet.
Beschreibung	description		string	Beschreibung des isheets.
status	status		string	Status des isheets.
Accesstype	accesstype		string	Access-Typ des isheets.
type	type		string	Typ des isheets.
viewlink	viewlink		string	Link zum Anzeigen des iSheets.
allowsections	allowsections		string	Gibt an, ob Abschnitte zulässig sind.
allowlookup	allowlookup		string	Gibt an, ob Nachschlagefelder aktiviert sind.
displayisheet	displayisheet		string	Anzeigeoptionen für das iSheet.
searchasdefaultview	searchasdefaultview		string	Gibt an, ob die Suche die Standardansicht ist.
enableversion	enableversion		string	Versionsverwaltung aktiviertes Flag.
enablesheetalerter	enablesheetalerter		string	Kennzeichnen, um Blattwarnungen zu aktivieren.
alertercondition	alertercondition		string	Bedingungen zum Auslösen von Warnungen.
overrideitemmodifieddate	overrideitemmodifieddate		string	Änderungsdatumskennzeichnung außer Kraft setzen.
enablebulkinsertupdate	enablebulkinsertupdate		string	Masseneinfügung/Aktualisierung aktivieren.
FieldDescriptions	fielddescriptions		string	Feldbeschreibungen für das iSheet.
enablerowlocking	enablerowlocking		string	Aktivieren Sie die Sperrung auf Zeilenebene.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Mehrfachzeilentextkennzeichnung abschneiden.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Zeichenlimit für mehrteilige Abkürzung.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Wiederverwendung von Auswahllistenwerten zulassen.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Wiederverwendung von Bewertungslistenwerten zulassen.
allowIsheetComments	allowIsheetComments		string	Kommentare in iSheet zulassen.
shareRecordsLimit	shareRecordsLimit		integer	Grenzwert für Datensätze, die freigegeben werden dürfen.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Grenzwert für aktivierte Datensatzfreigaben.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Aktivieren sie die Formularfreigabe zum Hinzufügen von Datensätzen.
Recordcount	recordcount		string	Aktuelle Datensatzanzahl.
sheettypeid	sheettypeid		integer	Typ-ID des iSheet
ermöglichen	enable		string	Aktivieren Sie die QA-Funktion.
userid	userid		integer	Benutzer-ID.
E-Mail	email		string	E-Mail-Adresse.
httpavatar	httpavatar		string	HTTP-URL des Avatars.
Avatar	avatar		string	Avatarbild.
userlink	userlink		string	Link zu Benutzerprofilen.
httplink	httplink		string	HTTP-Link zum Benutzerprofil.
phone	phone		string	Telefonnummer.
mobile	mobile		string	Handynummer.
Abteilung	department		string	Abteilung des Benutzers.
ermöglichen	enable		string	Aktivieren der Vertrags express-Integration.
adminnote	adminnote		string	Administrative Notizen im Zusammenhang mit der Website.
Startdatum	startdate		string	Das Startdatum des Websitevorgangs.
Enddatum	enddate		string	Das Enddatum des Vorgangs der Website.
createddate	createddate		string	Das Datum, an dem die Website erstellt wurde.
archiviertes Datum	archiveddate		string	Das Datum, an dem die Website archiviert wurde.
clientno	clientno		string	Die Clientnummer, die der Website zugeordnet ist.
matterno	matterno		string	Die mit der Website verknüpfte Nummer der Angelegenheit.
Landingpage	landingpage		string	Die URL der Zielseite für die Website.
link	link		string	Ein Link im Zusammenhang mit der Website.
status	status		string	Der aktuelle Status der Website.
statusid	statusid		integer	Der Bezeichner für den Status der Website.
size	size		string	Die Größe der Website.
Abrechnungsnoten	billingnotes		string	Hinweise zur Abrechnung für die Website.
billingnextinvoicedate	billingnextinvoicedate		string	Das Datum der nächsten Rechnung für die Website.
billinglastinvoicedate	billinglastinvoicedate		string	Das Datum der letzten Rechnung für die Website.
filepagecount	filepagecount		string	Die Gesamtzahl der Seitenanzahl von Dateien auf der Website.
maxpagecount	maxpagecount		string	Die maximal zulässige Seitenanzahl für Dateien auf der Website.
sitehttplink	sitehttplink		string	Der HTTP-Link zur Website.
isSyncable	isSyncable		integer	Gibt an, ob die Website synchronisiert werden kann.
enforceusergroups	enforceusergroups		string	Die für die Website erzwungenen Benutzergruppen.
csvSiteCategory	csvSiteCategory		string	Die Kategorie der Website im CSV-Format.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Der Name der Website in der Standardsprache.
sichtbar	visible		integer	Gibt an, ob die Website sichtbar ist.
siteLogoName	siteLogoName		string	Der Name der Logodatei der Website.
siteLogoFileSize	siteLogoFileSize		integer	Die Dateigröße des Websitelogos.
siteLogoHeight	siteLogoHeight		integer	Die Höhe des Websitelogos.
siteLogoWidth	siteLogoWidth		integer	Die Breite des Websitelogos.
siteStatus	siteStatus		integer	Der Statuscode der Website.
applySiteTerms	applySiteTerms		integer	Gibt an, ob Websitebegriffe angewendet werden.
siteTerm	siteTerm		string	Die Bedingungen, die auf die Website angewendet werden.
termType	termType		integer	Der Auf die Website angewendete Ausdruckstyp.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Gibt an, ob Websitebedingungen bei der nächsten Anmeldung erforderlich sind.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Gibt an, ob Standardwebsitebegriffe aktiviert sind.
advancedQAPermission	advancedQAPermission		integer	Die erweiterte QA-Berechtigungsstufe für die Website.
isIntern	isInternal		integer	Gibt an, ob die Website intern ist.
Psm	psm		integer	Der Product Service Manager-Bezeichner.
siteLabelDisplay	siteLabelDisplay		string	Die Anzeigebezeichnung für die Website.
allowSiteAdministration	allowSiteAdministration		integer	Gibt an, ob die Websiteverwaltung zulässig ist.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	So aktivieren Sie den Kennwortschutz auf Websiteebene.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	So aktivieren Sie den Kennungsschutz auf Websiteebene.
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Gibt an, ob die Kenncodeauthentifizierung eine Authentifizierungs-App verwendet.
sitePassword	sitePassword		string	Das Kennwort, das der Website zugeordnet ist.
ipRestrictionEnable	ipRestrictionEnable		integer	So aktivieren Sie IP-Einschränkungen für den Websitezugriff.
availableIP	availableIP		string	Durch Trennzeichen getrennte Liste der IP-Adressen, die für den Zugriff auf die Website zulässig sind.
highqDrive	highqDrive		integer	Gibt an, ob die HighQ Drive-Integration aktiviert ist.
applySiteHomePage	applySiteHomePage		integer	So wenden Sie eine benutzerdefinierte Startseite für die Website an.
siteHomePage	siteHomePage		string	URL der benutzerdefinierten Homepage für die Website.
siteHomePageType	siteHomePageType		integer	Typ der Startseite.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	So legen Sie die nächste Anmeldung auf der Homepage der Website fest.
applyDisplayContent	applyDisplayContent		integer	So wenden Sie Anzeigeinhaltseinstellungen an.
displayContent	displayContent		string	Inhalt, der auf der Website angezeigt werden soll.
rssSecurity	rssSecurity		integer	Sicherheitsstufe für RSS-Feed.
encryptedPassword	encryptedPassword		integer	Gibt an, ob das Websitekennwort verschlüsselt ist.
availableIPRangeCSV	availableIPRangeCSV		string	Durch Trennzeichen getrennte Liste der IP-Adressbereiche, die für den Zugriff auf die Website zulässig sind.
siteModuleID	siteModuleID		integer	Bezeichner für das Websitemodul.
icalSecurity	icalSecurity		integer	iCal-Feed-Sicherheitsstufe.
defaultDisplayContent	defaultDisplayContent		string	Standardinhalt, der auf der Website angezeigt werden soll.
defaultEmailAlert	defaultEmailAlert		integer	So aktivieren Sie standardmäßige E-Mail-Benachrichtigungen.
excelReportFooter	excelReportFooter		integer	Enthält eine Fußzeile in Excel-Berichten.
excelReportFooterText	excelReportFooterText		string	Text, der in der Fußzeile von Excel-Berichten angezeigt werden soll.
announcementMLJSON	announcementMLJSON		string	JSON-formatierte Ankündigungen für die Website.
templateType	templateType		integer	Typ der Vorlage, die für die Website verwendet wird.
templateLicence	templateLicence		integer	Lizenztyp für die Websitevorlage.
openChannelAppID	openChannelAppID		string	Anwendungs-ID für die Integration des geöffneten Kanals.
itemid	itemid		integer	Bezeichner für das Element, das der Website zugeordnet ist.
sitemetadatasheetid	sitemetadatasheetid		integer	ID des Metadatenblatts, das der Website zugeordnet ist.
meine Website	mysite		boolean	Gibt an, ob dies die persönliche Website des Benutzers ist.
lastaccesseddate	lastaccesseddate		string	Datum und Uhrzeit des letzten Zugriffs auf die Website.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Standardmetadatenregisterkarte für den Website-Viewer.
documentMetadataViewId	documentMetadataViewId		integer	Dokumentmetadaten für ansichtsbezeichner.
folderMetadataViewId	folderMetadataViewId		integer	Ordnermetadaten für ansichtsbezeichner.
docSort	docSort		integer	Die Sortierreihenfolge von Dokumenten.
folderSort	folderSort		integer	Die Sortierreihenfolge von Ordnern.
defaultFolderRenderView	defaultFolderRenderView		integer	Bestimmt den Standardansichtsmodus für Ordner.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Der Standardspeicherort für Aufgabenanlagen.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Der eindeutige Bezeichner des Ordners, der als Standardspeicherort für Aufgabenanlagen festgelegt ist.
Favorit	favourite		string	Lieblingsstatus.
enabledocumentredaction	enabledocumentredaction		boolean	Gibt an, ob die Dokument redaction für die Website aktiviert ist.
Erwähnungsgruppen	mentiongroups		integer	Die genannten Gruppen.
enablefilerelationships	enablefilerelationships		boolean	Gibt an, ob Dateibeziehungen aktiviert sind.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Die Berechtigungsstufe, die zum Verwalten von Dateibeziehungen erforderlich ist.

Gibt zurück

Body: site

Websitegruppe aktualisieren

Vorgangs-ID:: updateSiteGroup

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
API-Version	version	True	string	Ausgabe
Die ID der Website	siteid	True	string	Die ID der Website.
API-Version	groupid	True	string	`The ID of the site group.`
name	name		string
id	id		integer
copypermissionsfrom	copypermissionsfrom		string
message	message		string
typeID	typeID		integer
type	type		string
numberofusers	numberofusers		string
erstellt	created		string
modified	modified		string
systemGroupID	systemGroupID		integer
Beschreibung	description		string
basicusergroup	basicusergroup		integer

Gibt zurück

Body: sitegroup

Definitionen

ErrorDBO

Name	Pfad	Typ
summary	summary	string
ref	ref	string
link	link	string

DocumentDBO

Name	Pfad	Typ	Beschreibung
docid	docid	string	Dokument-ID.

columns

Name	Pfad	Typ	Beschreibung
Spalte	column	array of object
items	column	object

LocationDBO

Name	Pfad	Typ	Beschreibung
addressline1	addressline1	string	Erste Zeile der Adresse.
addressline2	addressline2	string	Zweite Zeile der Adresse.
addressline3	addressline3	string	Dritte Zeile der Adresse.
city	city	string	Stadt der Adresse.
Staat	state	string	Der Status der Adresse.
country	country	string	Land der Adresse.
Postleitzahl	postcode	string	Postleitzahl der Adresse.

Nutzername

Name	Pfad	Typ	Beschreibung
title	title	string	Der Titel des Benutzers.
Vorname	firstname	string	Vorname des Benutzers.
Nachname	lastname	string	Nachname des Benutzers.
3.000	goesby	string	bevorzugter Name des Benutzers.

MetadataListDBO

Name	Pfad	Typ	Beschreibung
Metadatenname	metadataname	array of string
Metadatenwert	metadatavalue	array of string

NameValueLink

Name	Pfad	Typ	Beschreibung
id	id	string	Link-ID
name	name	string	Linkname.
value	value	string	Linkwert.

Link

Name	Pfad	Typ	Beschreibung
link	link	array of NameValueLink

ExperiencesDBO

Name	Pfad	Typ	Beschreibung
Erfahrung	experience	array of string

GroupsDBO

Name	Pfad	Typ	Beschreibung
group	group	array of string

user

Name	Pfad	Typ	Beschreibung
userid	userid	integer	Benutzer-ID.
Folgende	following	boolean	Folgende.
E-Mail	email	string	E-Mail-Adresse.
name	name	UserName
userlink	userlink	string	Benutzerlink.
httplink	httplink	string	HTTP-Link.
httpavatar	httpavatar	string	HTTP Avatar.
Avatar	avatar	integer	Avatar des Benutzers.
externalid	externalid	string	Externe ID.
dateofbirth	dateofbirth	string	Geburtsdatum.
phone	phone	string	Telefonnummer.
Jobtitle	jobtitle	string	Berufsbezeichnung.
mobile	mobile	string	Handynummer.
Abteilung	department	string	Analyse.
status	status	string	Status:
Org	org	string	Organisation.
orgName	orgName	string	Name der Organisation.
location	location	LocationDBO
img	img	string	Bild.
erlebnisse	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
customlink	customlink	Link
Messaginglink	messaginglink	Link
Sekretärname	secretaryname	string	Sekretärname.
Secretarymail	secretarymail	string	Sekretär Mail.
bio	bio	string	Biografie des Benutzers.
Sourcetype	sourcetype	string	Quelltyp.
Spezialitäten	specialities	string	Spezialitäten.
reportsto	reportsto	string	Der Benutzer meldet den aktuellen Benutzer an.
metadata	metadata	MetadataListDBO
Gruppen	groups	GroupsDBO
Nachsilbe	suffix	string	Suffix des Benutzernamens.
atomlink	atomlink	string	Atom-Link, der dem Benutzer zugeordnet ist.
link	link	string	Dem Benutzer zugeordneter Link.
loggeduserlike	loggeduserlike	integer	Anzahl der Gefällt mir vom angemeldeten Benutzer.
Nutzername	userName	string	Benutzername.

Nutzer

Name	Pfad	Typ	Beschreibung
user	user	array of user

FolderDBOV1

Name	Pfad	Typ	Beschreibung
folderid	folderid	string	Der eindeutige Bezeichner des erstellten Ordners.

DmsDBO

Name	Pfad	Typ	Beschreibung
dmsfolderid	dmsfolderid	string	Der DMS-Ordnerbezeichner.
dmsParentFolderID	dmsParentFolderID	string	Der BEzeichner des übergeordneten DMS-Ordners.
dmscreateddate	dmscreateddate	date-time	Das Datum, an dem der DMS-Ordner erstellt wurde.
dmsmodifiedBy	dmsmodifiedBy	string	Der Benutzer, der den DMS-Ordner zuletzt geändert hat.
dmsdatabasename	dmsdatabasename	string	Der Name der DMS-Datenbank.
dmslink	dmslink	boolean	Gibt an, ob ein DMS-Link verfügbar ist.
dmslinkby	dmslinkby	string	Der Benutzer, der den DMS-Ordner verknüpft hat.

sitegroup

Name	Pfad	Typ
name	name	string
id	id	integer
copypermissionsfrom	copypermissionsfrom	string
message	message	string
typeID	typeID	integer
type	type	string
numberofusers	numberofusers	string
erstellt	created	string
modified	modified	string
systemGroupID	systemGroupID	integer
Beschreibung	description	string
basicusergroup	basicusergroup	integer

Adresse

Name	Pfad	Typ	Beschreibung
addressid	addressid	string	Eindeutiger Bezeichner für die Adresse.
addressline1	addressline1	string	Erste Zeile der Adresse.
addressline2	addressline2	string	Zweite Zeile der Adresse.
addressline3	addressline3	string	Dritte Zeile der Adresse.
city	city	string	Stadt der Adresse.
Staat	state	string	Der Status der Adresse.
country	country	string	Land der Adresse.
Postleitzahl	postCode	string	Postleitzahl der Adresse.
knownas	knownas	string	Alternativer Name oder Spitzname für die Adresse.

IntegrationUserDBO

Name	Pfad	Typ	Beschreibung
index	index	integer	Eindeutiger Index für den Benutzer.
userid	userid	integer	Eindeutiger Bezeichner für den Benutzer.
Vorname	firstname	string	Vorname des Benutzers.
Nachname	lastname	string	Nachname des Benutzers.
practicegroup	practicegroup	string	Übungsgruppe, zu der der Benutzer gehört.
langcode	langcode	string	Sprachcode des Benutzers.
localeID	localeID	string	Gebietsschema-ID des Benutzers.
publicprofile	publicprofile	string	Öffentliches Profil des Benutzers.
pwpid	pwpid	string	PWP-ID des Benutzers.
usertypeid	usertypeid	string	Benutzertyp-ID.
systemuser	systemuser	string	Systembenutzerkennzeichnung.
E-Mail	email	string	Email Adresse des Benutzers.
phone	phone	string	Telefonnummer des Benutzers.
mobile	mobile	string	Mobiltelefonnummer des Benutzers.
Abteilung	department	string	Abteilung des Benutzers.
Org	org	string	Die Organisation, zu der der Benutzer gehört.
location	location	LocationDBO
address	address	Address
erlebnisse	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
Messaginglink	messaginglink	Link
customlink	customlink	Link
img	img	string
reportsto	reportsto	string
metadata	metadata	MetadataListDBO
Gruppen	groups	GroupsDBO
externalid	externalid	string	Externe ID des Benutzers.
Jobtitle	jobtitle	string	Position des Benutzers.
Sekretärname	secretaryname	string	Name des Sekretärs des Benutzers.
Secretarymail	secretarymail	string	E-Mail-Adresse des Sekretärs des Benutzers.
Spezialitäten	specialities	string	Besonderheiten des Benutzers.
title	title	string	Der Titel des Benutzers.
3.000	goesby	string	bevorzugter Name des Benutzers.
Nachsilbe	suffix	string	Suffix des Benutzernamens.
atomlink	atomlink	string	Atom-Link, der dem Benutzer zugeordnet ist.
bio	bio	string	Biografie des Benutzers.
dateOfBirth	dateOfBirth	string	Geburtsdatum des Benutzers.
link	link	string	Dem Benutzer zugeordneter Link.
status	status	string	Status des Benutzers.
Statuscode	statuscode	string	Statuscode des Benutzers.
message	message	string	Nachricht, die dem Benutzer zugeordnet ist.
Sourcetype	sourcetype	string	Quelltyp des Benutzers.
orgid	orgid	string	Organisations-ID.
ifpartner	ifpartner	string	Partnerkennzeichnung.
emaildomain	emaildomain	string	E-Mail-Domäne des Benutzers.
einladungsent	invitationsent	string	Gesendete Einladungskennzeichnung.
Erstellt von	createdby	string	Benutzer, der den Datensatz erstellt hat.
createddate	createddate	string	Datum, an dem der Datensatz erstellt wurde.
geändertvon	modifiedby	string	Benutzer, der den Datensatz geändert hat.
modifieddate	modifieddate	string	Datum, an dem der Datensatz geändert wurde.
lastlogindate	lastlogindate	string	Datum der letzten Anmeldung.
invalidlogins	invalidlogins	string	Anzahl ungültiger Anmeldeversuche.
publicwebsiteprofileid	publicwebsiteprofileid	string	Profil-ID der öffentlichen Website.
resetpassworddate	resetpassworddate	string	Datum, an dem das Kennwort zurückgesetzt wurde.
Avatar	avatar	string	Avatarbild-URL.
followingcount	followingcount	integer	Anzahl der Benutzer, die gefolgt werden.
Followercount	followercount	integer	Anzahl der Follower.
Folgende	following	boolean	Folgende Kennzeichnung.
role	role	string	Rolle des Benutzers.
isbasicuser	isbasicuser	string	Standardbenutzerkennzeichnung.
encryptedUserId	encryptedUserId	string	Verschlüsselte Benutzer-ID.
selbstregistern	selfregistered	integer	Selbst registrierte Kennzeichnung.
registeredWith2FA	registeredWith2FA	string	Zweistufige Authentifizierungsregistrierungskennzeichnung.
isIntern	isInternal	integer	Interne Benutzerkennzeichnung.
orgName	orgName	string	Name der Organisation.

Standort

Name	Pfad	Typ	Beschreibung
id	id	integer	Der Websitebezeichner.
Websitename	sitename	string	Der Name der Website.
role	role	string	Die Rolle der Website.
sitedescription	sitedescription	string	Die Beschreibung der Website.
enabledmodules	enabledmodules	string	Eine Liste der module, die für die Website aktiviert sind.
sitefolderID	sitefolderID	string	Der Bezeichner für den Ordner der Website.
sitefolderpermission	sitefolderpermission	string	Die Berechtigungsstufe für den Ordner der Website.
Modul	module	ModuleDBO
adminnote	adminnote	string	Administrative Notizen im Zusammenhang mit der Website.
Startdatum	startdate	string	Das Startdatum des Websitevorgangs.
Enddatum	enddate	string	Das Enddatum des Vorgangs der Website.
createddate	createddate	string	Das Datum, an dem die Website erstellt wurde.
archiviertes Datum	archiveddate	string	Das Datum, an dem die Website archiviert wurde.
clientno	clientno	string	Die Clientnummer, die der Website zugeordnet ist.
matterno	matterno	string	Die mit der Website verknüpfte Nummer der Angelegenheit.
Landingpage	landingpage	string	Die URL der Zielseite für die Website.
link	link	string	Ein Link im Zusammenhang mit der Website.
status	status	string	Der aktuelle Status der Website.
statusid	statusid	integer	Der Bezeichner für den Status der Website.
size	size	string	Die Größe der Website.
Abrechnungsnoten	billingnotes	string	Hinweise zur Abrechnung für die Website.
billingnextinvoicedate	billingnextinvoicedate	string	Das Datum der nächsten Rechnung für die Website.
billinglastinvoicedate	billinglastinvoicedate	string	Das Datum der letzten Rechnung für die Website.
filepagecount	filepagecount	string	Die Gesamtzahl der Seitenanzahl von Dateien auf der Website.
maxpagecount	maxpagecount	string	Die maximal zulässige Seitenanzahl für Dateien auf der Website.
sitehttplink	sitehttplink	string	Der HTTP-Link zur Website.
isSyncable	isSyncable	integer	Gibt an, ob die Website synchronisiert werden kann.
enforceusergroups	enforceusergroups	string	Die für die Website erzwungenen Benutzergruppen.
csvSiteCategory	csvSiteCategory	string	Die Kategorie der Website im CSV-Format.
siteNameInDefaultLanguage	siteNameInDefaultLanguage	string	Der Name der Website in der Standardsprache.
sichtbar	visible	integer	Gibt an, ob die Website sichtbar ist.
siteLogoName	siteLogoName	string	Der Name der Logodatei der Website.
siteLogoFileSize	siteLogoFileSize	integer	Die Dateigröße des Websitelogos.
siteLogoHeight	siteLogoHeight	integer	Die Höhe des Websitelogos.
siteLogoWidth	siteLogoWidth	integer	Die Breite des Websitelogos.
siteStatus	siteStatus	integer	Der Statuscode der Website.
applySiteTerms	applySiteTerms	integer	Gibt an, ob Websitebegriffe angewendet werden.
siteTerm	siteTerm	string	Die Bedingungen, die auf die Website angewendet werden.
termType	termType	integer	Der Auf die Website angewendete Ausdruckstyp.
nextLoginSiteTerms	nextLoginSiteTerms	integer	Gibt an, ob Websitebedingungen bei der nächsten Anmeldung erforderlich sind.
defaultSiteTermsEnable	defaultSiteTermsEnable	integer	Gibt an, ob Standardwebsitebegriffe aktiviert sind.
advancedQAPermission	advancedQAPermission	integer	Die erweiterte QA-Berechtigungsstufe für die Website.
isIntern	isInternal	integer	Gibt an, ob die Website intern ist.
Psm	psm	integer	Der Product Service Manager-Bezeichner.
siteLabelDisplay	siteLabelDisplay	string	Die Anzeigebezeichnung für die Website.
allowSiteAdministration	allowSiteAdministration	integer	Gibt an, ob die Websiteverwaltung zulässig ist.
siteLevelPasswordEnable	siteLevelPasswordEnable	integer	So aktivieren Sie den Kennwortschutz auf Websiteebene.
siteLevelPasscodeEnable	siteLevelPasscodeEnable	integer	So aktivieren Sie den Kennungsschutz auf Websiteebene.
passcodeUsingAuthApp	passcodeUsingAuthApp	integer	Gibt an, ob die Kenncodeauthentifizierung eine Authentifizierungs-App verwendet.
sitePassword	sitePassword	string	Das Kennwort, das der Website zugeordnet ist.
ipRestrictionEnable	ipRestrictionEnable	integer	So aktivieren Sie IP-Einschränkungen für den Websitezugriff.
availableIP	availableIP	string	Durch Trennzeichen getrennte Liste der IP-Adressen, die für den Zugriff auf die Website zulässig sind.
highqDrive	highqDrive	integer	Gibt an, ob die HighQ Drive-Integration aktiviert ist.
applySiteHomePage	applySiteHomePage	integer	So wenden Sie eine benutzerdefinierte Startseite für die Website an.
siteHomePage	siteHomePage	string	URL der benutzerdefinierten Homepage für die Website.
siteHomePageType	siteHomePageType	integer	Typ der Startseite.
nextLoginSiteHomePage	nextLoginSiteHomePage	integer	So legen Sie die nächste Anmeldung auf der Homepage der Website fest.
applyDisplayContent	applyDisplayContent	integer	So wenden Sie Anzeigeinhaltseinstellungen an.
displayContent	displayContent	string	Inhalt, der auf der Website angezeigt werden soll.
rssSecurity	rssSecurity	integer	Sicherheitsstufe für RSS-Feed.
encryptedPassword	encryptedPassword	integer	Gibt an, ob das Websitekennwort verschlüsselt ist.
availableIPRangeCSV	availableIPRangeCSV	string	Durch Trennzeichen getrennte Liste der IP-Adressbereiche, die für den Zugriff auf die Website zulässig sind.
siteModuleID	siteModuleID	integer	Bezeichner für das Websitemodul.
icalSecurity	icalSecurity	integer	iCal-Feed-Sicherheitsstufe.
defaultDisplayContent	defaultDisplayContent	string	Standardinhalt, der auf der Website angezeigt werden soll.
defaultEmailAlert	defaultEmailAlert	integer	So aktivieren Sie standardmäßige E-Mail-Benachrichtigungen.
excelReportFooter	excelReportFooter	integer	Enthält eine Fußzeile in Excel-Berichten.
excelReportFooterText	excelReportFooterText	string	Text, der in der Fußzeile von Excel-Berichten angezeigt werden soll.
announcementMLJSON	announcementMLJSON	string	JSON-formatierte Ankündigungen für die Website.
templateType	templateType	integer	Typ der Vorlage, die für die Website verwendet wird.
templateLicence	templateLicence	integer	Lizenztyp für die Websitevorlage.
openChannelAppID	openChannelAppID	string	Anwendungs-ID für die Integration des geöffneten Kanals.
itemid	itemid	integer	Bezeichner für das Element, das der Website zugeordnet ist.
sitemetadatasheetid	sitemetadatasheetid	integer	ID des Metadatenblatts, das der Website zugeordnet ist.
meine Website	mysite	boolean	Gibt an, ob dies die persönliche Website des Benutzers ist.
lastaccesseddate	lastaccesseddate	string	Datum und Uhrzeit des letzten Zugriffs auf die Website.
defaultViewerMetaDataTab	defaultViewerMetaDataTab	integer	Standardmetadatenregisterkarte für den Website-Viewer.
documentMetadataViewId	documentMetadataViewId	integer	Dokumentmetadaten für ansichtsbezeichner.
folderMetadataViewId	folderMetadataViewId	integer	Ordnermetadaten für ansichtsbezeichner.
docSort	docSort	integer	Die Sortierreihenfolge von Dokumenten.
folderSort	folderSort	integer	Die Sortierreihenfolge von Ordnern.
defaultFolderRenderView	defaultFolderRenderView	integer	Bestimmt den Standardansichtsmodus für Ordner.
isTaskAttachmentDefault	isTaskAttachmentDefault	integer	Der Standardspeicherort für Aufgabenanlagen.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId	integer	Der eindeutige Bezeichner des Ordners, der als Standardspeicherort für Aufgabenanlagen festgelegt ist.
Favorit	favourite	string	Lieblingsstatus.
enabledocumentredaction	enabledocumentredaction	boolean	Gibt an, ob die Dokument redaction für die Website aktiviert ist.
Erwähnungsgruppen	mentiongroups	integer	Die genannten Gruppen.
enablefilerelationships	enablefilerelationships	boolean	Gibt an, ob Dateibeziehungen aktiviert sind.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel	integer	Die Berechtigungsstufe, die zum Verwalten von Dateibeziehungen erforderlich ist.

ModuleDBO

Name	Pfad	Typ
Heim	home	HomeDBO
activity	activity	ActivityDBO
Dokument	document	DocumentDBO
Blog	blog	BlogDBO
Wiki	wiki	WikiDBO
Aufgabe	task	TaskDBO
Ereignis	event	EventDBO
isheet	isheet	ISheetDBO
qa	qa	QaDBO
Kontakte	people	PeopleDBO
contractexpress	contractexpress	ContractExpressDBO

HomeDBO

Name	Pfad	Typ	Beschreibung
ermöglichen	enable	string	Status für HomeDBO aktivieren.

ActivityDBO

Name	Pfad	Typ	Beschreibung
ermöglichen	enable	string	Status für ActivityDBO aktivieren.
Mikroblog	microblog	string	Mikrobloginhalte, die mit ActivityDBO verknüpft sind.

BlogDBO

Name	Pfad	Typ	Beschreibung
blogTitle	blogTitle	string	Titel des Blogbeitrags.
blogContent	blogContent	string	Inhalt des Blogbeitrags.
showComment	showComment	integer	den Kommentar anzeigen.
tagListe	tagList	array of string	Liste der Tags, die dem Blog zugeordnet sind.
status	status	integer	Status des Blogbeitrags.
siteID	siteID	integer	Bezeichner für die zugeordnete Website.
Autor	author	string	Autor des Blogs.
categoryList	categoryList	array of string	Kategorien, die dem Blogbeitrag zugewiesen sind.
notificationTypeID	notificationTypeID	integer	Bezeichner für den Benachrichtigungstyp.
message	message	string	Nachrichteninhalte im Zusammenhang mit dem Blog.
messageCode	messageCode	integer	Code, der der Nachricht zugeordnet ist.
externalID	externalID	string	Externer Bezeichner, der mit dem Blog verknüpft ist.
publishDatum	publishDate	string	Veröffentlichungsdatum des Blogs.
Prozesstyp	processtype	string	Prozesstyp, der dem Blog zugeordnet ist.
ermöglichen	enable	string	Status für BlogDBO aktivieren.

WikiDBO

Name	Pfad	Typ	Beschreibung
wikiid	wikiid	integer	Eindeutiger Bezeichner für das Wiki.
currentversionid	currentversionid	integer	Bezeichner für die aktuelle Version des Wikis
parentwikiid	parentwikiid	integer	Bezeichner für das übergeordnete Wiki.
Wikititle	wikititle	string	Der Titel des Wikis.
Wikicontent	wikicontent	string	Inhalt des Wikis.
Kommentar anzeigen	showcomment	integer	Gibt an, ob Kommentare aktiviert sind.
createddate	createddate	string	Erstellungsdatum des Wikis.
modifieddate	modifieddate	string	Datum der letzten Änderung des Wikis.
Tagliste	taglist	string	Durch Trennzeichen getrennte Liste von Tags, die dem Wiki zugeordnet sind.
Wikipath	wikipath	string	Pfad für den Zugriff auf das Wiki.
wikidraftid	wikidraftid	integer	Bezeichner für die Entwurfsversion des Wikis.
Entwurfstyp	drafttype	string	Typ des Entwurfs, der dem Wiki zugeordnet ist.
status	status	integer	Aktueller Status des Wikis.
wikiversionid	wikiversionid	integer	Versionsbezeichner des Wikis.

TaskDBO

Name	Pfad	Typ	Beschreibung
index	index	string	Index oder Bezeichner für die Aufgabe.
parenttaskid	parenttaskid	integer	Bezeichner für die übergeordnete Aufgabe.
taskid	taskid	integer	Eindeutiger Bezeichner des Vorgangs.
title	title	string	Titel des Vorgangs.
Beschreibung	description	string	Detaillierte Beschreibung des Vorgangs.
Fälligkeitsdatum	duedate	string	Fälligkeitsdatum für den Vorgangsabschluss.
Startdatum	startdate	string	Startdatum, an dem die Aufgabe initiiert wurde.
mattermaptaskid	mattermaptaskid	string	Bezeichnerverknüpfung mit dem Vorgang "Matter Map".
type	type	string	Typ oder Kategorie des Vorgangs.
dependenton	dependenton	string	Aufgaben, von denen dieser Vorgang abhängt.
daysfromdependent	daysfromdependent	string	Anzahl der Tage ab dem abhängigen Vorgang.
ignoreweekend	ignoreweekend	integer	Gibt an, ob Wochenenden in der Planung ignoriert werden.
duration	duration	integer	Dauer, um den Vorgang abzuschließen.
resource	resource	string	Dem Vorgang zugeordnete Ressourcen.

EventDBO

Name	Pfad	Typ	Beschreibung
eventTitle	eventTitle	string	Titel des Ereignisses.
eventContent	eventContent	string	Inhalt des Ereignisses.
showComment	showComment	integer	Gibt an, ob Kommentare für das Ereignis aktiviert sind.
tagListe	tagList	array of string	Liste der Tags, die dem Ereignis zugeordnet sind.
status	status	integer	Aktueller Status des Ereignisses.
siteID	siteID	integer	Bezeichner für die Website.
Kontakt	contact	string	Kontaktinformationen für das Ereignis.
categoryList	categoryList	array of string	Kategorien, unter denen das Ereignis aufgeführt wird.
notificationTypeID	notificationTypeID	integer	Der Benachrichtigungstyp im Zusammenhang mit dem Ereignis.
message	message	string	Die Meldung des Ereignisses.
messageCode	messageCode	integer	Der Nachrichtencode des Ereignisses.
externalID	externalID	string	Der externe Bezeichner.
startDate	startDate	string	Das Startdatum des Ereignisses.
Enddatum	endDate	string	Das Enddatum des Ereignisses.
startTime	startTime	string	Die Startzeit des Ereignisses.
endTime	endTime	string	Die Endzeit des Ereignisses.
location	location	string	Der Ort des Ereignisses.
Autor	author	string	Der Autor des Ereignisses.
Prozesstyp	processtype	string	Die Prozesszeit des Ereignisses.
ermöglichen	enable	string	Enable's the event.

ISheetDBO

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutiger Bezeichner für das iSheet.
title	title	string	Titel des iSheet.
Beschreibung	description	string	Beschreibung des isheets.
status	status	string	Status des isheets.
Accesstype	accesstype	string	Access-Typ des isheets.
type	type	string	Typ des isheets.
viewlink	viewlink	string	Link zum Anzeigen des iSheets.
allowsections	allowsections	string	Gibt an, ob Abschnitte zulässig sind.
allowlookup	allowlookup	string	Gibt an, ob Nachschlagefelder aktiviert sind.
displayisheet	displayisheet	string	Anzeigeoptionen für das iSheet.
searchasdefaultview	searchasdefaultview	string	Gibt an, ob die Suche die Standardansicht ist.
enableversion	enableversion	string	Versionsverwaltung aktiviertes Flag.
enablesheetalerter	enablesheetalerter	string	Kennzeichnen, um Blattwarnungen zu aktivieren.
alertercondition	alertercondition	string	Bedingungen zum Auslösen von Warnungen.
overrideitemmodifieddate	overrideitemmodifieddate	string	Änderungsdatumskennzeichnung außer Kraft setzen.
enablebulkinsertupdate	enablebulkinsertupdate	string	Masseneinfügung/Aktualisierung aktivieren.
FieldDescriptions	fielddescriptions	string	Feldbeschreibungen für das iSheet.
enablerowlocking	enablerowlocking	string	Aktivieren Sie die Sperrung auf Zeilenebene.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled	string	Mehrfachzeilentextkennzeichnung abschneiden.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval	string	Zeichenlimit für mehrteilige Abkürzung.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse	string	Wiederverwendung von Auswahllistenwerten zulassen.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse	string	Wiederverwendung von Bewertungslistenwerten zulassen.
allowIsheetComments	allowIsheetComments	string	Kommentare in iSheet zulassen.
shareRecordsLimit	shareRecordsLimit	integer	Grenzwert für Datensätze, die freigegeben werden dürfen.
shareRecordsLimitEnabled	shareRecordsLimitEnabled	integer	Grenzwert für aktivierte Datensatzfreigaben.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing	string	Aktivieren sie die Formularfreigabe zum Hinzufügen von Datensätzen.
Recordcount	recordcount	string	Aktuelle Datensatzanzahl.
sheettypeid	sheettypeid	integer	Typ-ID des iSheet

QaDBO

Name	Pfad	Typ	Beschreibung
ermöglichen	enable	string	Aktivieren Sie die QA-Funktion.

PeopleDBO

Name	Pfad	Typ	Beschreibung
person	person	array of PersonDBO

PersonDBO

Name	Pfad	Typ	Beschreibung
userid	userid	integer	Benutzer-ID.
E-Mail	email	string	E-Mail-Adresse.
httpavatar	httpavatar	string	HTTP-URL des Avatars.
Avatar	avatar	string	Avatarbild.
userlink	userlink	string	Link zu Benutzerprofilen.
httplink	httplink	string	HTTP-Link zum Benutzerprofil.
phone	phone	string	Telefonnummer.
mobile	mobile	string	Handynummer.
Abteilung	department	string	Abteilung des Benutzers.

ContractExpressDBO

Name	Pfad	Typ	Beschreibung
ermöglichen	enable	string	Aktivieren der Vertrags express-Integration.

FolderDBOV2

Name	Pfad	Typ	Beschreibung
name	name	string	Ordnername.
Beschreibung	description	string	Ordnerbeschreibung.
parentFolderID	parentFolderID	integer	Id des übergeordneten Ordners.
accessInherited	accessInherited	integer	Zugriffsvererbungsstatus.
batchID	batchID	string	Batchbezeichner
DMS	dms	DmsDBO
id	id	integer	Ordner-ID.
link	link	string	Ordnerlink.
createddate	createddate	string	Erstellungsdatum.
modifieddate	modifieddate	string	Änderungsdatum.
child	child	integer	Untergeordnete Ordner.
filecount	filecount	integer	Anzahl der Dateien.
Erstellt von	createdby	UserDBO
geändertvon	modifiedby	UserDBO
folderid	folderid	integer	Ordner-ID.
dmsfolderid	dmsfolderid	string	DMS-Ordnerbezeichner.
siteid	siteid	integer	ID der Website
location	location	string	Ordnerspeicherort.
Erlaubnis	permission	PermissionDBO
contentstatus	contentstatus	integer	Inhaltsstatus.
Automatische Nummerierung	autonumbering	string	Automatische Nummerierungskonfiguration.
Ordnergröße	foldersize	string	Ordnergröße.
sharedstatus	sharedstatus	integer	Freigabestatus.
favoritestatus	favouritestatus	integer	Lieblingsstatus.
foldertype	foldertype	string	Ordnertyp.
Artikel-ID	itemId	integer	Element-ID.
folderMetadataSheetId	folderMetadataSheetId	integer	Ordnermetadaten der Blatt-ID.

UserDBO

Name	Pfad	Typ	Beschreibung
Vorname	firstname	string	Vorname.
Nachname	lastname	string	Nachname.
E-Mail	email	string	E-Mail-Adresse.
userid	userid	integer	Benutzer-ID.

PermissionDBO

Name	Pfad	Typ	Beschreibung
Ansicht	view	integer	Berechtigung anzeigen.
edit	edit	integer	Berechtigung bearbeiten.
delete	delete	integer	Berechtigung löschen.
addEditAllFiles	addEditAllFiles	integer	Berechtigung "Alle Dateien hinzufügen/bearbeiten".
Administrator	admin	integer	Administratorberechtigung.
viewAllFiles	viewAllFiles	integer	Alle Dateiberechtigungen anzeigen.
disableSave	disableSave	integer	"Berechtigung speichern" deaktivieren.
uploadFile	uploadFile	integer	Dateiberechtigung hochladen.
updateFile	updateFile	integer	Dateiberechtigung aktualisieren.
deleteFile	deleteFile	integer	Dateiberechtigung löschen.

ProgressiveKeyDBO

Name	Pfad	Typ	Beschreibung
Progressiver Schlüssel	progressivekey	string	Schlüssel für progressive Vorgänge.
siteid	siteid	integer	Bezeichner für die Website.
progressiver Schlüsselstatus	progressivekeystatus	string	Status des progressiven Schlüssels.
userid	userid	integer	Bezeichner für den Benutzer.
responsebody	responsebody	string	Textkörper der Antwort.
message	message	string	Nachrichteninhalt.
messagecode	messagecode	string	Code, der der Nachricht zugeordnet ist.
integrationResponseDBO	integrationResponseDBO	IntegrationResponseDBO
columns	columns	ColumnErrorsDBO
items	items	ItemErrorsDBO
importisheettemplate	importisheettemplate	importISheetTemplateDBO
Fehler	error	ErrorDBO
Inhaltstyp	contentType	string	Inhaltstyp.
failedEntities	failedEntities	integer	Anzahl der fehlgeschlagenen Entitäten.
downloadlink	downloadlink	string	Link zum Herunterladen von Inhalten.
Anhang	attachment	Attachment
link	link	string	Verknüpfter Link.
documentid	documentid	integer	Bezeichner für das Dokument.
Progresskey	progresskey	string	Statusschlüssel für die Nachverfolgung.
progresskeystatus	progresskeystatus	string	Status des Statusschlüssels.

IntegrationResponseDBO

Name	Pfad	Typ	Beschreibung
integrationResponseUsersObject	integrationResponseUsersObject	IntegrationResponseUsersObject
failedEntities	failedEntities	integer	Anzahl der Entitäten, bei denen die Verarbeitung fehlgeschlagen ist.
successEntities	successEntities	integer	Anzahl der Entitäten, die erfolgreich verarbeitet wurden.

IntegrationResponseUsersObject

Name	Pfad	Typ	Beschreibung
user	user	array of IntegrationUserDBO

ColumnErrorsDBO

Name	Pfad	Typ	Beschreibung
Spalte	column	array of ColumnErrorDBO
failedEntities	failedEntities	integer	Anzahl der Entitäten, die aufgrund von Spaltenfehlern fehlgeschlagen sind.
successEntities	successEntities	integer	Anzahl der Entitäten, die erfolgreich verarbeitet wurden.

ColumnErrorDBO

Name	Pfad	Typ	Beschreibung
index	index	integer	Indexposition der Spalte mit Fehler.
columnid	columnid	integer	Eindeutiger Bezeichner der Spalte mit Fehler.
name	name	string	Name der Spalte mit Fehler.
status	status	string	Status, der die Fehlerbedingung angibt.
Statuscode	statuscode	string	Code, der den Fehlerstatus darstellt.
message	message	string	Detaillierte Fehlermeldung.

ItemErrorsDBO

Name	Pfad	Typ	Beschreibung
item	item	array of ItemErrorDBO
failedEntities	failedEntities	integer	Anzahl der Entitäten, die aufgrund von Elementfehlern fehlgeschlagen sind.
successEntities	successEntities	integer	Anzahl der Entitäten, die trotz Elementfehlern erfolgreich verarbeitet wurden.

ItemErrorDBO

Name	Pfad	Typ	Beschreibung
index	index	integer	Indexposition des Elements mit Fehler.
columns	columns	ColumnErrorsDBO
itemid	itemid	string	Eindeutiger Bezeichner des Elements mit Fehler.
externalid	externalid	string	Externer Bezeichner, der dem Element zugeordnet ist.
id	id	string	Interner Bezeichner des Elements.
name	name	string	Name des Elements mit Fehler.
status	status	string	Status, der die Fehlerbedingung angibt.
Statuscode	statuscode	string	Code, der den Fehlerstatus darstellt.
message	message	string	Detaillierte Fehlermeldung.
successdeletedcount	successdeletedcount	integer	Anzahl der erfolgreich gelöschten Entitäten.
failurecount	failurecount	integer	Anzahl der Entitäten, bei denen die Verarbeitung fehlgeschlagen ist.
failedEntities	failedEntities	integer	Anzahl der Entitäten, die aufgrund von Elementfehlern fehlgeschlagen sind.
successEntities	successEntities	integer	Anzahl der Entitäten, die erfolgreich verarbeitet wurden.

importISheetTemplateDBO

Name	Pfad	Typ	Beschreibung
linkedtemplateid	linkedtemplateid	integer	Bezeichner der verknüpften Vorlage.
Aliasname	aliasname	string	Aliasname für die Vorlage.
linkedisheet	linkedisheet	string	Bezeichner des verknüpften Eingabeblatts.
Importdaten	importdata	string	Daten, die aus der Vorlage importiert werden sollen.
appendisheetname	appendisheetname	string	Name des Blatts, an das Daten angefügt werden sollen.
templateparametergroups	templateparametergroups	ISheetTemplateParameterGroups
templateSheetIdMap	templateSheetIdMap	object
templateId	templateId	integer	Bezeichner der Vorlage.
templateTitle	templateTitle	string	Titel der Vorlage.
viewIDs	viewIDs	string	Durch Trennzeichen getrennte Liste der Ansichts-IDs.

ISheetTemplateParameterGroups

Name	Pfad	Typ	Beschreibung
templateparametergroup	templateparametergroup	array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Name	Pfad	Typ	Beschreibung
templateruleid	templateruleid	integer	Isheet-Vorlagenparametergruppe.
templateparameter	templateparameter	array of ISheetTemplateParameter

ISheetTemplateParameter

Name	Pfad	Typ	Beschreibung
id	id	integer	Bezeichner des isheet-Vorlagenparameters.
name	name	string	Name des isheet-Vorlagenparameters.
Daten	data	string	Daten des isheet-Vorlagenparameters.

Attachment

Name	Pfad	Typ	Beschreibung
file	file	string	Der Dateiinhalt.
name	name	string	Der Name der Anlage.
order	order	string	Die Reihenfolge der Anlage.
id	id	integer	Eindeutiger Bezeichner für die Anlage.
Erweiterung	extension	string	Dateiendung.
parentfolderid	parentfolderid	integer	ID des übergeordneten Ordners.
filehttplink	filehttplink	string	HTTP-Link für den Zugriff auf die Datei.
folderpath	folderpath	string	Pfad zum Ordner, der die Datei enthält.
folderhttplink	folderhttplink	string	HTTP-Link zum Ordner.
filesize	filesize	integer	Größe der Datei in Byte.
redactionStatus	redactionStatus	boolean	Gibt an, ob die Datei redacted ist.
displayname	displayname	string	Anzeigename der Anlage.
siteid	siteid	integer	ID der Website, die der Anlage zugeordnet ist.

Freigeben über

HighQ (Vorschau)

HighQ

Überblick

Authentifizierung

Verbindervorgänge

ISheet-Modul

Dokumentressourcen-APIs

ISheet-Administrator-API

Benutzeroperationen

Dokument- und Websiteverwaltung

Erste Schritte

Parameter und Einstellungen

Problembehandlung und Einschränkungen

Zusätzliche Ressourcen

Lizenzierung und Support

Drosselungsgrenzwerte

Aktionen

Abrufen einer Liste von iSheet-Elementen

Parameter

Gibt zurück

Abrufen einer Liste von Ordnern

Parameter

Gibt zurück

Abrufen von Dateiinformationen

Parameter

Gibt zurück

Abrufen von iSheet-Spalten

Parameter

Gibt zurück

Abrufen von Ordnerinformationen

Parameter

Gibt zurück

Archivbenutzer

Parameter

Benutzer hinzufügen

Parameter

Gibt zurück

Benutzerliste abrufen

Parameter

Gibt zurück

Dokumente verschieben

Parameter

Hinzufügen einer vorhandenen Gruppe zur Website

Parameter

Gibt zurück

Hochladen einer Datei

Parameter

Ordner erstellen

Parameter

Gibt zurück

So erstellen Sie das iSheet-Element

Parameter

Gibt zurück

Website aktualisieren

Parameter

Website hinzufügen

Parameter

Gibt zurück

Websitegruppe aktualisieren

Parameter

Gibt zurück

Definitionen

ErrorDBO

DocumentDBO

columns

LocationDBO

Nutzername

MetadataListDBO

NameValueLink

Link

ExperiencesDBO

GroupsDBO

user

Nutzer

FolderDBOV1

DmsDBO

sitegroup

Adresse

IntegrationUserDBO