QPP NextGen (Vorschau)
NextGen (QPP) NextGen ist ein cloudbasiertes Komponenten-Content Management System (CCMS) zur Automatisierung der Veröffentlichung streng regulierter Unternehmensinhalte. Der QPP NextGen Connector hilft dabei, Daten aus Ihrem Inhaltsökosystem in beide Richtungen zu verschieben, um Prozesse zu vereinfachen und die Marktzeit zu beschleunigen.
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 | Technischer Support von Quark |
| URL | https://quarksoftware.my.site.com |
| support_cases@quark.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Quark Software Inc. |
| Webseite | https://www.quark.com/ |
| Datenschutzrichtlinie | https://www.quark.com/privacy-policy |
| Kategorien | Inhalt und Dateien; Produktivität |
NextGen (QPP) NextGen ist ein cloudbasiertes Komponenten-Content Management System (CCMS) zur Automatisierung der Veröffentlichung streng regulierter Unternehmensinhalte. Der QPP NextGen Connector hilft dabei, Daten aus Ihrem Inhaltsökosystem in beide Richtungen zu verschieben, um Prozesse zu vereinfachen und die Marktzeit zu beschleunigen.
Voraussetzungen
- Sie benötigen eine QPP-NG Umgebung (v3.3 oben) und QPP-NG Lizenzen, um unseren Connector zu verwenden.
- Sie müssen über einen vorhandenen Client (Connection), vorzugsweise getrennt, für die Mandanten erstellt werden, für die die Aktionen und Trigger dieses Connectors interagieren sollen. Weitere Details finden Sie im Abschnitt "Anmeldeinformationen abrufen".
- Grundlegendes zur Verwendung von Power Automate und Abrufen von Werten mithilfe dynamischer Inhalte oder aus einer anderen Aktionsantwort mithilfe des Erstellers von Abfragen.
So erhalten Sie Anmeldeinformationen
Beim Erstellen einer neuen Verbindung mit unserem Verbinder sehen Sie 3 Params. Details zum Erwerb der einzelnen Werden unten freigegeben. Erstellen und ManaWhile erstellen eine neue Verbindung mit unserem Connector, Benutzer sehen 3 Params. Details zum Erwerb der einzelnen Werden unten freigegeben. Das Erstellen und Verwalten von QPP-NG Verbindungen sollte vom Administratorbenutzer erfolgen. Wenden Sie sich an Ihren administrator für QPP-NG Umgebungen.
Sie können Ihre Anmeldeinformationen auch entsprechend benennen, um sie später leicht zu identifizieren. Wechseln Sie zu "Connections " in Power Automate, suchen Sie nach dem Connectornamen, und bearbeiten Sie eine vorhandene Verbindung, und geben Sie einen geeigneten Namen an.
- Client-ID: Sie können zu Ihrer gewünschten QPP-NG Admin-App für Mandanten navigieren und dann "Connections" festlegen>. Hier können sie eine neue Verbindung erstellen oder eine vorhandene verbindung verwenden. Geben Sie einfach den Verbindungsnamen für die Client-ID ein.
- Geheimer Clientschlüssel: Navigieren Sie wie die Client-ID zu "Verbindungen ", und geben Sie einfach "Geheim" für die vorhandene Verbindung ein. Regenerieren Sie das Geheimnis, wenn Sie es nicht haben. Geheime Schlüssel sollten für vorhandene Verbindungen sicher gespeichert werden, die vom Administrator verwaltet werden. Wenden Sie sich an den Administrator, bevor Sie den geheimen Schlüssel neu generieren.
- Hostname: Der Hostname für den QPP-NG Mandanten, den Sie erstellen möchten, um mit unserem Connector zu interagieren. Beispiel (yourtenantname.app.quark.com). Sollte die URL sichtbar sein, wenn Sie auf Ihre QPP-NG Umgebung zugreifen.
Nach dem Erstellen von Anmeldeinformationen können Sie die Anmeldeinformationen testen, um festzustellen, ob Anmeldeinformationen korrekt sind.
Einfache Aktionen wie "getUser" können von unserem Connector in einem manuellen Ablauf verwendet werden. Testen Sie den Fluss mit Standardfeldern.
Beim erstmaligen Erstellen einer Verbindung sind einige Fehlercodes, die angezeigt werden können, wie unten dargestellt:
- Ungültige Host-URL (500): Überprüfen Sie ihren Hostnamen für die QPP-NG Umgebung erneut, die Client-ID und der geheime Schlüssel sollte zu dieser Verbindung gehören.
- Nicht autorisiert/unauthorized_client (401): Stellen Sie für ungültige Client- oder ungültige Clientanmeldeinformationen sicher, dass die Client-ID und der geheime Clientschlüssel gültig sind und zum verwendeten Hostnamen gehören.
Erste Schritte mit QPP-NG Integrationshub
Um zu beginnen, können Sie eine Vielzahl von Ereignissen von Typobjekten, Sammlungen usw. von Ihrem QPP-NG Mandanten mit integriertem Trigger abhören.
- Erstellen Sie einen neuen Automatisierungsfluss in Power Automate.
- Wählen Sie unseren QPP-NG Connector und dann einen Trigger aus.
- Füllen Sie die erforderlichen Felder aus. Weitere Informationen finden Sie im Abschnitt "Webhook-Trigger" in der Github Readme-Dokumentation.
- Wählen Sie die entsprechende Verbindung für den QPP-NG Mandanten aus, in dem Sie Webhook registrieren möchten. Sie können auch neue Verbindungen erstellen. Führen Sie die im Abschnitt "So wird's gemacht: Abrufen von Anmeldeinformationen " beschriebenen Schritte aus.
- Speichern Sie den Flow. Dadurch wird die Registrierungsanforderung im Hintergrund ausgeführt. Wenn Sie zur Seite mit den Flussdetails zurückkehren(oder auf die Schaltfläche "Zurück") klicken, sollte oben eine grüne Unterstreichung angezeigt werden, in der erwähnt wird, dass alles gut funktioniert hat und der Fluss bereit ist, ausgelöst zu werden.
- Sobald der Fluss einmal ausgeführt wird, können Sie die Webhook-Antwort auf die Ausführung des Flusses weiter abrufen und die Antwort verwenden, um dynamische Inhalte zu generieren. Hierfür können Sie die OOTB-Aktion des Parse json verwenden.
- Falls dies der erste Webhook mit diesem Änderungstyp (Ereignis) ist, der für den QPP-NG Mandanten registriert ist, müssen Sie 15 Minuten warten, bevor der Webhook aktiviert wird, und dann können Sie erwarten, dass der Fluss ausgelöst wird.
Wenn fehler in der Ablaufprüfung mit dem Webhook-Trigger vorhanden sind, wird in Power Automate in der Flussprüfung rot angezeigt. Öffnen Sie ihn, und überprüfen Sie den Fehler. Im Folgenden finden Sie einige der Fehler, die auftreten können, und die Schritte zur Entschärfung.
- Webhook mit dem Namen ist bereits vorhanden Geben Sie entweder einen eindeutigen Namen für den Webhook an, oder verwenden Sie den Löschwebhook-Vorgang mit derselben Verbindung in einem anderen manuellen Fluss. Wählen Sie den Webhook mit demselben Namen aus, und löschen Sie ihn. Weitere Informationen zu Webhooks finden Sie auf dem Portal für Entwickler von Aspx.
- Ungültige Anforderung(400) Bitte überprüfen Sie die Params gemäß dokumentation und Fehlerdetails.
- Ressource nicht gefunden (404) & Ortsheader fehlt in abonnierten Anforderungen Löschen Sie den Fluss, und erstellen Sie dann einen neuen Webhook-Trigger und -Fluss. Wenn der Fluss groß ist, duplizieren Sie den Fluss, und während Sie den Fluss aktivieren und speichern, versucht Power Automate, eine neue Webhook-Registrierung auszuführen.
Bekannte Probleme und Einschränkungen
- Derzeit können Sie keine Params für einen bereits registrierten Webhook-Trigger aktualisieren. Löschen Sie als Problemumgehung den aktuellen Webhook-Vorgang aus dem Fluss, und fügen Sie einen neuen QPP-NG Webhook-Trigger an seiner Stelle hinzu. Um den zuvor registrierten Webhook aus der QPP-NG-Umgebung zu löschen, erstellen Sie einen neuen manuellen Fluss mit dem Löschvorgang, wählen Sie den vorherigen Webhook aus der Dropdownliste aus, und führen Sie den Fluss aus. Wenn diese Problemumgehung nicht funktioniert und der Fluss groß ist, duplizieren Sie den Fluss, und nachdem Sie Webhook-Details aktualisiert haben, speichern und aktivieren Sie ihn. Dadurch wird auch eine neue Webhook-Registrierung erfolgreich erstellt.
- Sie können den Fluss auch deaktivieren, bevor Sie einen neuen Trigger löschen und erstellen. Dadurch wird auch sichergestellt, dass Ihr neuer Webhook registriert wird.
- Wenn der QPP-NG Webhook-Dienst den registrierten Webhook-Trigger 3 Mal nicht aufrufen kann, wird der Webhook deaktiviert.
- Das Speichern bestimmter Aktionen ohne angegebene (leere) Parameter gibt einen Fehler zurück (erwarten Sie einen Wert im Textkörper).
- Wenn dies der erste Webhook mit diesem Änderungstyp (Ereignis) ist, müssen Sie 15 Minuten warten, bevor der Webhook aktiviert wird, und Dann können Sie erwarten, dass der Fluss ausgelöst wird.
- Verwenden Sie die Legacy-Designeransicht, um die beste Erfahrung zu erzielen, da aufgrund der laufenden Entwicklung Probleme mit dem neuen Designer auftreten können, solche Aktionen mit Problemen mit dem neuen Designer sind CheckOut, SetAttributeValues , InitNewCheckin & CreateQuery.
Häufige Fehler und Abhilfemaßnahmen
- Beim Registrieren von Webhooks Trigger als ersten Schritt kann es bei der Registrierung bei unserem Dienst ein Problem geben, wenn details nicht ordnungsgemäß bereitgestellt werden. Dies kann nach dem Speichern des Flusses mit dem Trigger eingegrenzt und zum Seitenfenster "Flussdetails" zurückgegeben werden, in dem die letzten 28 Tage angezeigt werden. Wenn es rot angezeigt wird, bedeutet dies, dass der Webhook nicht ordnungsgemäß registriert wurde. Bitte überprüfen Sie den Fehler. Wenn der Fehler aufgrund des Location-Headers fehlt oder die Ressource nicht gefunden wird, versuchen Sie, den Trigger erneut zu löschen und zu erstellen.
- Wenn Ihre Flüsse nicht ausgelöst werden, kann es auf einen vorhandenen Webhook zurückzuführen sein, der als Endpunkt registriert ist, der nicht vorhanden ist, z. B. ein gelöschter Fluss usw. Führen Sie in einer solchen Situation API-https://{Host.name}/webhooks/api/v3/registrations mit Ihrem API-Token aus, um eine Liste aller registrierten Webhooks in der QPP-NG-Umgebung abzurufen, und verwenden Sie diese Antwort, um solche Webhooks mithilfe der Löschwebhooks-Aktion zu entfernen. Darüber hinaus müssen Sie sicherstellen, dass der Webhooks-Dienst ordnungsgemäß konfiguriert und von Ihrem Support von Connectorhttps://quarksoftware.my.site.com () ausgeführt wird.
- Wenn Sie keinen privilegierten Benutzer oder einen Authentifizierungsfehler erhalten, überprüfen Sie, ob der für den Identitätswechsel angegebene Benutzername über ausreichende Berechtigungen in Ihrem QPP-NG Mandanten verfügt,
- Bei spezifischen Problemen mit Aktionen finden Sie Beispiele und Dokumentationen, die im Open Source-Repository auf Github in Readme.md Datei freigegeben wurden, oder weitere Informationen zu Endpunkten und Funktionen finden Sie im Portal für Action-Entwickler .
Häufig gestellte Fragen
Kann ich die Aktionen und Trigger mit verschiedenen QPP-NG Umgebungen verwenden?
Ja, es ist möglich. Sie müssen lediglich den Parameter "Hostname" gemäß der Umgebung eingeben und entsprechende Verbindungen zu dieser Umgebung verwenden.
Können Sie uns helfen, wenn wir an etwas hängen bleiben oder Zweifel haben?
Absolut. Nur E-Mail [E-Mail geschützt] (https://quarksoftware.my.site.com) und stellen Sie sicher, dass Sie den Microsoft Power Automate Connector erwähnen, wenn Sie Ihr Problem beschreiben.
Wo erhalte ich weitere Informationen zu den Aktionen und Endpunkten?
Weitere Informationen zu den verschiedenen Aspx-APIs finden Sie hier. Navigieren Sie einfach zur Registerkarte "Inhaltsplattform". Da dieser Connector nur eine Teilmenge der tatsächlichen API enthält, die für die QPP-NG-Plattform möglich ist, kann diese Website verwendet werden, um weitere Aktionen und Endpunkte zu untersuchen und anzufordern, indem eine Featureanforderung unter [E-Mail geschützt] protokolliert wird.
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Client-ID (clientId) | Schnur | Geben Sie die Client-ID aus Ihren Dienstanmeldeinformationen an. | Richtig |
| Geheimer Clientschlüssel (clientSecret) | securestring | Geben Sie den geheimen Clientschlüssel aus Ihren Dienstanmeldeinformationen an. | Richtig |
| Hostname | Schnur | Angeben des Hostnamens | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abfrage erstellen |
Erstellen Sie eine Abfrage mit Definition und Details im Anforderungstext. Ausführliche Informationen finden Sie in GitHub-Dokumenten. |
| Abrufen aller Abfragen |
Diese Anforderung gibt alle Abfragen mit dieser Definition zurück. Details finden Sie unter Github-Dokumentationen. |
| Abrufen von Attributwerten aus IDs |
Rufen Sie Attributwerte für durch Trennzeichen getrennte IDs ab. Weitere Informationen finden Sie in der Github-Dokumentation. |
| Abrufen von Gruppen für eine Sammlung |
Diese Anforderung gibt ein Array anwendbarer Routinggruppen für die angegebene Auflistung für den angegebenen Workflow und Status zurück. Weitere Informationen finden Sie in der GitHub-Dokumentation. |
| Abrufen von Inhaltstypeninformationen nach Name |
Diese Anforderung wird verwendet, um Inhaltstypinformationen anhand des Inhaltstypnamens abzurufen. Details finden Sie in Github-Dokumentationen. |
| Abrufen von Objektmetadaten |
Abrufen von Objektdaten für die angegebene Objekt-ID. Weitere Informationen finden Sie in der Github-Dokumentation. |
| Abrufen von Paginierten Abfrageergebnissen mit Filtern |
Diese Anforderung gibt paginiertes Abfrageelement und Details einer im System gespeicherten Abfrage mit einem bestimmten Filter in der Abfrage zurück. Weitere Informationen finden Sie in der GitHub-Dokumentation. |
| Abrufen von Ressourcendownloadinformationen |
Die Anforderung gibt Informationen zum Herunterladen von Ressourcen zurück, die zusammen mit der Download blob-Aktion zum Herunterladen des Ressourcendatenstroms verwendet werden können. Weitere Informationen finden Sie in der GitHub-Dokumentation. |
| Abrufen von untergeordneten Ressourcenbeziehungen |
Abrufen von untergeordneten Objektbeziehungen für eine übergeordnete Objekt-ID. Details finden Sie unter Github-Dokumentationen. |
| Alle Benutzer abrufen |
Diese Anforderung wird verwendet, um alle Benutzer abzurufen. Ausführliche Informationen finden Sie in Github-Dokumenten. |
| Attribute nach Name abrufen |
Gibt alle vorhandenen Attribute mit Metadaten in QPPNG Server für angegebene Namen zurück. Details finden Sie in GitHub-Dokumenten. |
| Attributewerte nach Name abrufen |
Rufen Sie Attributwerte für durch Kommas getrennte Namen ab. Details finden Sie in GitHub-Dokumenten. |
| Attributwerte festlegen |
Legen Sie Attributwerte für die QPP-Plattform fest. Weitere Informationen finden Sie in der Github-Dokumentation. |
| Attributzuordnung für Inhaltstyp aktualisieren |
Aktualisieren Sie die Attributzuordnung von Inhaltstypen und untergeordneten Elementen mit der angegebenen Attributzuordnung im Anforderungstext. Details finden Sie in GitHub-Dokumenten. |
| Benutzer nach ID abrufen |
Diese Anforderung wird verwendet, um die Metadaten eines angegebenen Benutzers abzurufen. Details finden Sie in GitHub-Dokumenten. |
| Benutzer nach Name abrufen |
Diese Anforderung gibt Benutzermetadaten zurück, die für den Benutzernamen spezifisch sind. Details finden Sie in GitHub-Dokumenten. |
| Download (Blob) |
Diese Anforderung wird verwendet, um die Datei vom Eingabedatenstrom von der Download-URL herunterzuladen. Details finden Sie in GitHub-Dokumenten. |
| Erstellt ein neues Attribut |
Erstellt ein neues Attribut und gibt seine ID zusammen mit einer Erfolgsmeldung zurück. Details finden Sie in GitHub-Dokumenten. |
| Erstellt ein neues Listen-Attribut |
Erstellt ein neues Attribut und gibt seine ID nach erfolgreicher Erstellung der Attributnachricht zurück. Weitere Informationen finden Sie in der GitHub-Dokumentation. |
| Gruppe nach Name abrufen |
Diese Anforderung gibt eine Gruppe zurück, die für den Gruppennamen spezifisch ist. |
| Gruppenmitglieder abrufen |
Diese Anforderung gibt eine Liste der Benutzer und alle ihre Metadaten zurück, die für die Gruppen-ID spezifisch sind. Details finden Sie in GitHub-Dokumenten. |
| Hochladen (Blob) |
Diese Anforderung wird zum Hochladen der Datei durch Eingabedatenstrom verwendet. Details finden Sie in GitHub-Dokumenten. |
| Initiieren des Eincheckens und Aktualisierens |
Die Anforderung checkt ein und aktualisiert eine bereits vorhandene Ressource in QPPNG. Die Ressource muss vor der Hand ausgecheckt werden. Verwenden Sie die Auscheckaktion vor. Weitere Informationen finden Sie in der GitHub-Dokumentation. |
| Ist Ein Benutzer ein Gruppenmitglied |
Diese Anforderung gibt entweder "true" oder "false" zurück, dass ein Benutzer gruppenspezifisch für die UserId ist. |
| Kasse |
Markiert die Ressource mit der angegebenen assetId als ausgecheckt. Ausführliche Informationen finden Sie in den Github-Dokumenten. |
| Löscht Webhook |
Löscht einen bereits vorhandenen Webhook für ein bestimmtes Ereignis und änderungstyp. Weitere Informationen finden Sie in der GitHub-Dokumentation. |
| Neues Einchecken initiieren |
Die Anforderung checkt eine lokale Datei gemäß der angegebenen Qpp-Attributwertearray ein, z. B. erforderliche Attributwerte sind Name, Sammlung, Erweiterung usw. zum Einchecken einer Ressource an QPPNG. Weitere Informationen finden Sie in der GitHub-Dokumentation. |
| Ressourcen-Async veröffentlichen |
Gibt die Kontext-ID für die Veröffentlichung der Ressource zurück. Wird zum Abrufen des Veröffentlichungsstatus verwendet. Details finden Sie in GitHub-Dokumenten. |
| Token gemäß Grant-Typ abrufen |
Diese Anforderung ruft das Token für den angegebenen Benutzernamen und das Kennwort für QPPNG ab. Details finden Sie in GitHub-Dokumenten. |
| Veröffentlichungsstatus abrufen |
Abrufen des Veröffentlichungsstatus für ein bestimmtes Objekt. Ausführliche Informationen finden Sie in den Github-Dokumenten. |
| Workflow anhand des Namens abrufen |
Diese Anforderung gibt alle Metadaten eines angegebenen Workflows anhand des Namens zurück. Details finden Sie unter Github-Dokumentationen. |
| Übergeordnete Ressourcenbeziehungen abrufen |
Diese Anforderung gibt die Liste der Beziehungen für eine übergeordnete Objektbeziehung zurück. Details finden Sie in GitHub-Dokumenten. |
Abfrage erstellen
Erstellen Sie eine Abfrage mit Definition und Details im Anforderungstext. Ausführliche Informationen finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Anzahl der zu überspringenden Attribute
|
_skiptoken | True | integer |
Anzahl der Attribute, die aus der Dropdownliste "Attribut" übersprungen werden sollen. |
|
Abfragename
|
queryName | True | string |
Name der Abfrage. |
|
Parametriert
|
parameterized | boolean |
Gibt an, ob die Abfrage parametrisiert ist. |
|
|
Attribut-ID
|
attributeId | integer |
Attribut-ID für suche. |
|
|
Attributtyp
|
type | integer |
Typ des für die Bedingung ausgewählten Attributs. |
|
|
Vergleichsoperator
|
comparisonOperator | integer |
Vergleichsoperator für die Bedingung. |
|
|
Negiert
|
negated | boolean |
Gibt an, ob die Bedingung negiert wird. |
|
|
Wert für die Suche nach
|
value | string |
wert für "Suchen nach" aus. |
|
|
Logischer Operator
|
logicalOperator | integer |
Logischer Und ODER-Operator für die Bedingung. |
|
|
Spalten-ID
|
columnId | True | integer |
ID der Anzeigespalte. |
|
Breite
|
width | True | integer |
Breite der Anzeigespalte. |
|
Attributspalte
|
attributeColumn | True | boolean |
Gibt an, ob es sich bei der Spalte um eine Attributspalte handelt. |
|
Anzeigemodus
|
displayMode | True | integer |
Einstellung des Anzeigemodus. |
Gibt zurück
Neu erstellte Abfrage-ID.
- Neu erstellte Abfrage-ID
- integer
Abrufen aller Abfragen
Diese Anforderung gibt alle Abfragen mit dieser Definition zurück. Details finden Sie unter Github-Dokumentationen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
Gibt zurück
- response
- array of QueryDefinition
Abrufen von Attributwerten aus IDs
Rufen Sie Attributwerte für durch Trennzeichen getrennte IDs ab. Weitere Informationen finden Sie in der Github-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Objekt-ID
|
assetId | True | integer |
ID für die Ressource auf der QPPNG-Plattform, auf die verwiesen wird. |
|
QPPNG-Attribut-IDs
|
attributeIds | True | string |
Attribut-IDs sollten auf die Attribut-IDs des QPP-Servers verweisen. |
Gibt zurück
- response
- array of AttributeValue
Abrufen von Gruppen für eine Sammlung
Diese Anforderung gibt ein Array anwendbarer Routinggruppen für die angegebene Auflistung für den angegebenen Workflow und Status zurück. Weitere Informationen finden Sie in der GitHub-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
ID für QPPNG-Auflistung
|
collectionId | True | integer |
Variable collectionId sollte auf die QPPNG-Auflistungs-ID verweisen. |
Gibt zurück
Abrufen von Inhaltstypeninformationen nach Name
Diese Anforderung wird verwendet, um Inhaltstypinformationen anhand des Inhaltstypnamens abzurufen. Details finden Sie in Github-Dokumentationen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Inhaltstypname
|
contentTypeName | True | string |
Name für den Inhaltstyp. |
Gibt zurück
- response
- array of ContentTypeInfo
Abrufen von Objektmetadaten
Abrufen von Objektdaten für die angegebene Objekt-ID. Weitere Informationen finden Sie in der Github-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Objekt-ID
|
assetId | True | integer |
ID für die Ressource auf der QPPNG-Plattform, auf die verwiesen wird. |
Gibt zurück
- Body
- Asset
Abrufen von Paginierten Abfrageergebnissen mit Filtern
Diese Anforderung gibt paginiertes Abfrageelement und Details einer im System gespeicherten Abfrage mit einem bestimmten Filter in der Abfrage zurück. Weitere Informationen finden Sie in der GitHub-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Vorhandene QPPNG-Abfrage-ID
|
queryId | True | integer |
Dies bezieht sich auf eine vorhandene QPPNG-Abfrage-ID. |
|
Abfrage-ID
|
queryId | integer |
Eindeutige ID der Abfrage. |
|
|
Abfragename
|
queryName | string |
Name der Abfrage. |
|
|
Besitzer-ID
|
ownerId | integer |
ID des Abfragebesitzers. |
|
|
Parametriert
|
parameterized | boolean |
Gibt an, ob die Abfrage parametrisiert ist. |
|
|
Spalten-ID
|
columnId | True | integer |
ID der Anzeigespalte. |
|
Breite
|
width | True | integer |
Breite der Anzeigespalte. |
|
Attributspalte
|
attributeColumn | True | boolean |
Gibt an, ob es sich bei der Spalte um eine Attributspalte handelt. |
|
Spalten-ID
|
columnId | integer |
ID der Spalte zum Sortieren. |
|
|
Descending
|
descending | boolean |
Gibt an, ob die Sortierung in absteigender Reihenfolge liegt. |
|
|
Attributspalte
|
attributeColumn | boolean |
Gibt an, ob die sortierte Spalte eine Attributspalte ist. |
|
|
Anzeigemodus
|
displayMode | True | integer |
Einstellung des Anzeigemodus. |
|
Attribut-ID
|
attributeId | integer |
ID des Attributs für die Gruppierung. |
|
|
Descending
|
descending | boolean |
Gibt an, ob sich die Gruppierung in absteigender Reihenfolge befindet. |
|
|
Erkunden des Modus
|
exploreMode | integer |
Moduseinstellung erkunden. |
|
|
Logischer Operator
|
logicalOperator | True | integer |
Logischer Operator für die Bedingung. |
|
Vergleichsoperator
|
comparisonOperator | True | integer |
Vergleichsoperator für die Bedingung. |
|
Negiert
|
negated | True | boolean |
Gibt an, ob die Bedingung negiert wird. |
|
Parametriert
|
parameterized | True | boolean |
Gibt an, ob die Bedingung parametrisiert ist. |
|
Typ
|
type | True | integer |
Typ der Bedingung. |
|
Attribut-ID
|
attributeId | True | integer |
Attribut-ID für suche. |
|
Wert für die Suche nach
|
value | True | string |
wert für "Suchen nach" aus. |
|
Inhaltstyp
|
contentType | integer |
ID des Inhaltstyps für den Abfragekontext. |
|
|
Auflistungen
|
collections | array of integer |
Liste der Sammlungs-IDs für den Abfragekontext. |
|
|
Rekursiv
|
recursive | boolean |
Gibt an, ob der Abfragekontext rekursiv ist. |
|
|
Alle Versionen einschließen
|
includeAllVersions | boolean |
Gibt an, ob alle Versionen im Abfragekontext enthalten sind. |
|
|
Filialen einschließen
|
includeBranches | boolean |
Gibt an, ob Verzweigungen im Abfragekontext enthalten sind. |
|
|
queryResults
|
queryResults |
Gibt zurück
Response-Element zum Auflisten von Abfrageergebnissen.
- Ergebniselement für Listenantwortabfragen
- ListResponseQueryResultElement
Abrufen von Ressourcendownloadinformationen
Die Anforderung gibt Informationen zum Herunterladen von Ressourcen zurück, die zusammen mit der Download blob-Aktion zum Herunterladen des Ressourcendatenstroms verwendet werden können. Weitere Informationen finden Sie in der GitHub-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Objekt-ID
|
assetId | True | integer |
AssetId sollte auf die Ressource des QPP-Servers verweisen. |
|
Nebenversion
|
minorVersion | integer |
Nebenversion sollte sich auf die Nebenversion der erforderlichen Ressource beziehen. Stellen Sie 0 bereit, um Metadaten der neuesten Version abzurufen. |
|
|
Hauptversion
|
majorVersion | integer |
Hauptversion sollte auf die Hauptversion der erforderlichen Ressource verweisen. Stellen Sie NULL bereit, um Metadaten der neuesten Version abzurufen. |
Gibt zurück
- Body
- AssetDownloadInfo
Abrufen von untergeordneten Ressourcenbeziehungen
Abrufen von untergeordneten Objektbeziehungen für eine übergeordnete Objekt-ID. Details finden Sie unter Github-Dokumentationen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Übergeordnete Objekt-ID
|
parentAssetId | True | integer |
Die übergeordnete Objekt-ID des QPP-Servers sollte auf die übergeordnete Ressource des QPP-Servers verweisen. |
Gibt zurück
- response
- array of AssetRelation
Alle Benutzer abrufen
Diese Anforderung wird verwendet, um alle Benutzer abzurufen. Ausführliche Informationen finden Sie in Github-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
Gibt zurück
Response-Element zum Auflisten von Benutzern.
- Listenantwortbenutzer
- ListResponseUser
Attribute nach Name abrufen
Gibt alle vorhandenen Attribute mit Metadaten in QPPNG Server für angegebene Namen zurück. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Attributnamen
|
attributeNames | True | string |
Der Attributname sollte auf den Attributnamen des QPP-Servers verweisen (durch Trennzeichen getrennt, wenn mehrere). |
Gibt zurück
- response
- array of Attribute
Attributewerte nach Name abrufen
Rufen Sie Attributwerte für durch Kommas getrennte Namen ab. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Objekt-ID
|
assetId | True | integer |
AssetId sollte auf die Ressource des QPP-Servers verweisen. |
|
Attributnamen
|
attributes | True | string |
Attributnamen-Zeichenfolge sollte auf die Attributnamen des QPPNG-Servers verweisen, durch Kommas getrennt, wenn mehrere. |
Gibt zurück
- response
- array of AttributeValue
Attributwerte festlegen
Legen Sie Attributwerte für die QPP-Plattform fest. Weitere Informationen finden Sie in der Github-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Objekt-ID
|
assetId | True | string |
QPP Platform Asset Id. |
|
Attribut-ID
|
attributeId | integer |
Bezeichner des Attributs. |
|
|
Typ
|
type | integer |
Typ des Attributs. |
|
|
Mehrwertige Werte
|
multiValued | boolean |
Gibt an, ob das Attribut mehrwertige Werte aufweist. |
|
|
Wert
|
attributeValue | object |
Wert. |
Attributzuordnung für Inhaltstyp aktualisieren
Aktualisieren Sie die Attributzuordnung von Inhaltstypen und untergeordneten Elementen mit der angegebenen Attributzuordnung im Anforderungstext. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Attribut-ID
|
attributeId | True | integer |
Attribut-IDs, die zugeordnet werden müssen. |
|
Inhaltstyp-IDs
|
contentTypeIds | True | string |
Inhaltstypen, denen diese Attribute zugeordnet werden müssen. |
Benutzer nach ID abrufen
Diese Anforderung wird verwendet, um die Metadaten eines angegebenen Benutzers abzurufen. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
QPPNG-Benutzer-ID
|
userId | True | integer |
ID für den QPPNG-Benutzer. |
Gibt zurück
- Body
- User
Benutzer nach Name abrufen
Diese Anforderung gibt Benutzermetadaten zurück, die für den Benutzernamen spezifisch sind. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Benutzername für QPPNG-Benutzer
|
userName | True | string |
Dies bezieht sich auf den Benutzernamen für QPPNG-Benutzer. |
Gibt zurück
- Body
- User
Download (Blob)
Diese Anforderung wird verwendet, um die Datei vom Eingabedatenstrom von der Download-URL herunterzuladen. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Authentifizierungstoken
|
authTokenforHeader | True | string |
Authentifizierungstoken ist hier separat erforderlich. TokenFromAuthWrapper-Aktion kann hier verwendet werden, um das Token abzurufen. |
|
Dateibezeichner
|
fileIdentifier | True | string |
Der Dateibezeichner bezieht sich auf den Dateityp. |
|
Kontext-ID
|
contextId | True | string |
Die Kontext-ID bezieht sich auf die Ressourceninformationen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Inhaltstyp
|
$content-type | string |
Der Inhaltstyp des Dokuments, z. B. Anwendung/PDF. |
|
Content
|
$content | byte |
Der Inhalt des Dokuments in base64-Codierung. |
Erstellt ein neues Attribut
Erstellt ein neues Attribut und gibt seine ID zusammen mit einer Erfolgsmeldung zurück. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Name
|
name | True | string |
Name des Attributs. |
|
Attributtyp
|
valueType | True | integer |
Typ des Attributs. |
Gibt zurück
Details eines Attributs, das einer Entität zugeordnet ist.
- Merkmal
- CreateAttributeSchema
Erstellt ein neues Listen-Attribut
Erstellt ein neues Attribut und gibt seine ID nach erfolgreicher Erstellung der Attributnachricht zurück. Weitere Informationen finden Sie in der GitHub-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Anzahl der anzuzeigenden Domänen
|
_skiptoken | True | integer |
Anzahl der Domänen, die aus der Dropdownliste "Domänen-ID" übersprungen werden sollen. |
|
Name
|
name | True | string |
Name des Attributs. |
|
Attributtyp
|
valueType | True | integer |
Der Typ des Attributs sollte eine Liste für den Listentyp sein. |
|
Mehrwertige Werte
|
multiValued | boolean |
Gibt an, ob das Attribut mehrere Werte enthalten kann. |
|
|
Eingeschränkter Zugriff
|
limitedAccess | boolean |
Gilt nur für Den Listentyp (Gibt an, ob das Attribut eingeschränkten Zugriff hat, um Rollen für dies vorher zu konfigurieren). |
|
|
Domänen-ID
|
domainId | integer |
Domänen-ID, die der vorhandenen Datenquellen-/Domänenliste zugeordnet ist. Verwenden Sie das Skip-Token, um in der Dropdownliste 20 Elemente zu durchlaufen. |
Gibt zurück
Details eines Attributs, das einer Entität zugeordnet ist.
- Merkmal
- CreateAttributeSchema
Gruppe nach Name abrufen
Diese Anforderung gibt eine Gruppe zurück, die für den Gruppennamen spezifisch ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Gruppenname
|
groupName | True | string |
Variable groupName sollte auf den Namen der QPP-Servergruppe verweisen. |
Gibt zurück
- Body
- Group
Gruppenmitglieder abrufen
Diese Anforderung gibt eine Liste der Benutzer und alle ihre Metadaten zurück, die für die Gruppen-ID spezifisch sind. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Gruppen-ID
|
groupId | True | integer |
Die Gruppen-ID sollte auf die QPPNG-Gruppe verweisen. |
Gibt zurück
- response
- array of User
Hochladen (Blob)
Diese Anforderung wird zum Hochladen der Datei durch Eingabedatenstrom verwendet. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Dateibezeichner
|
fileIdentifier | True | string |
Der Dateibezeichner bezieht sich auf den Dateityp. |
|
Kontext-ID
|
contextId | True | string |
Kontext-ID bezieht sich auf Ressourceninformationen. |
|
Input Stream-Ressource
|
InputStreamResource | True |
Eingabedatenstrom für Ressource, benötigt binäre Eingaben. |
Initiieren des Eincheckens und Aktualisierens
Die Anforderung checkt ein und aktualisiert eine bereits vorhandene Ressource in QPPNG. Die Ressource muss vor der Hand ausgecheckt werden. Verwenden Sie die Auscheckaktion vor. Weitere Informationen finden Sie in der GitHub-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Nebenversion erstellen
|
createMinorVersion | True | boolean |
Variable createMinorVersion sollte auf "true" oder "false" verweisen, um die Version zur Überprüfung zu erstellen. |
|
Objekt-ID
|
assetId | integer |
Objekt-ID für das einzucheckende Objekt. |
Gibt zurück
- Body
- AssetUploadInfo
Ist Ein Benutzer ein Gruppenmitglied
Diese Anforderung gibt entweder "true" oder "false" zurück, dass ein Benutzer gruppenspezifisch für die UserId ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
ID des QPPNG-Benutzers
|
userId | True | integer |
ID des QPPNG-Benutzers. |
|
ID für Gruppe in QPPNG
|
groupId | True | integer |
ID für Gruppe in QPPNG. |
Kasse
Markiert die Ressource mit der angegebenen assetId als ausgecheckt. Ausführliche Informationen finden Sie in den Github-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Objekt-ID
|
assetId | True | integer |
Variable assetId sollte auf die Ressource des QPP-Servers verweisen. |
|
Attribut-ID
|
attributeId | integer |
Bezeichner des Attributs. |
|
|
Typ
|
type | integer |
Typ des Attributs. |
|
|
Wert
|
attributeValue | object |
Wert. |
Gibt zurück
- Body
- Asset
Löscht Webhook
Löscht einen bereits vorhandenen Webhook für ein bestimmtes Ereignis und änderungstyp. Weitere Informationen finden Sie in der GitHub-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Name oder ID
|
nameOrId | True | string |
Name oder ID für den vorhandenen Webhook in der Umgebung. |
Gibt zurück
Neues Einchecken initiieren
Die Anforderung checkt eine lokale Datei gemäß der angegebenen Qpp-Attributwertearray ein, z. B. erforderliche Attributwerte sind Name, Sammlung, Erweiterung usw. zum Einchecken einer Ressource an QPPNG. Weitere Informationen finden Sie in der GitHub-Dokumentation.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Anzahl der zu überspringenden Attribute/Domänen
|
_skiptoken | True | integer |
Anzahl der zu überspringenden Attribute/Domänen. |
|
Nebenversion erstellen
|
createMinorVersion | True | boolean |
Variable createMinorVersion sollte auf "true" oder "false" verweisen, um die Version zur Überprüfung zu erstellen. |
|
Attribut-ID
|
attributeId | integer |
Attribut-ID. |
|
|
Attributtyp
|
type | integer |
Typ des Attributs. |
|
|
Mehrwertige Werte
|
multiValued | boolean |
Gibt an, ob das Attribut mehrwertige Werte aufweist. |
|
|
Id
|
id | integer |
Die ID, die dem Namen entspricht, z. B. für die Home-Sammlungs-ID 1, wird übernommen. |
|
|
Name
|
name | string |
Name für Attribut, z. B. Inhaltstypname oder Sammlungsname. |
|
|
Domänen-ID
|
domainId | integer |
Domänen-ID, die der vorhandenen Datenquellen-/Domänenliste zugeordnet ist. Die ID für die Domäne. |
|
|
Wert
|
value | string |
Wert des festzulegenden Attributs. |
|
|
Domänenwert-ID
|
id | integer |
Die ID für den Domänenwert selbst, z. B. die ID für einen Domänenwert für einen Benutzer, ist die Benutzer-ID, da die Liste "Benutzer" die Domäne ist. |
Gibt zurück
- Body
- AssetUploadInfo
Ressourcen-Async veröffentlichen
Gibt die Kontext-ID für die Veröffentlichung der Ressource zurück. Wird zum Abrufen des Veröffentlichungsstatus verwendet. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Objekt-ID
|
assetId | True | string |
Variable assetId sollte auf die Ressource des QPP-Servers verweisen. |
|
Id des Veröffentlichungskanals
|
publishingChannelId | True | string |
variable channelId sollte auf die id des zu verwendenden Kanals verweisen. |
Gibt zurück
Kontext-ID für die Veröffentlichung der Ressource. Verwenden Sie diese Option zum Abrufen des Veröffentlichungsstatus, um den Veröffentlichungsstatus zu überprüfen.
- Kontext-ID
- string
Token gemäß Grant-Typ abrufen
Diese Anforderung ruft das Token für den angegebenen Benutzernamen und das Kennwort für QPPNG ab. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Nutzername
|
username | True | string |
Geben Sie Ihren QPPNG-Umgebungsbenutzernamen ein, für den Sie ein Token abrufen müssen. |
|
Kennwort
|
password | True | string |
Geben Sie das Kennwort für den Benutzernamen ein. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zugriffstoken
|
access_token | string |
Das Token, das Zugriff auf die geschützten Ressourcen gewährt. |
|
Läuft ab in
|
expires_in | integer |
Die Dauer (in Sekunden), für die das Zugriffstoken gültig ist. |
|
Aktualisierung läuft ab in
|
refresh_expires_in | integer |
Die Dauer (in Sekunden), für die das Aktualisierungstoken gültig ist. |
|
Tokentyp
|
token_type | string |
Der Typ des Tokens (z. B. Bearer). |
|
Nicht vor der Richtlinie
|
not-before-policy | integer |
Die Zeit (in Sekunden), vor der das Token nicht verwendet werden kann. |
|
Umfang
|
scope | string |
Der Bereich des Zugriffstokens. |
Veröffentlichungsstatus abrufen
Abrufen des Veröffentlichungsstatus für ein bestimmtes Objekt. Ausführliche Informationen finden Sie in den Github-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Kontext-ID
|
contextId | True | string |
Kontext-ID |
Gibt zurück
- Body
- PublishingStatusInfo
Workflow anhand des Namens abrufen
Diese Anforderung gibt alle Metadaten eines angegebenen Workflows anhand des Namens zurück. Details finden Sie unter Github-Dokumentationen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Workflowname
|
workflowName | True | string |
Workflowname, für den Metadaten abgerufen werden müssen. |
Gibt zurück
Details eines Workflows.
- Arbeitsablauf
- Workflow
Übergeordnete Ressourcenbeziehungen abrufen
Diese Anforderung gibt die Liste der Beziehungen für eine übergeordnete Objektbeziehung zurück. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Untergeordnete Objekt-ID
|
childAssetId | True | integer |
Variable childAssetId sollte auf die untergeordnete Ressource des QPP-Servers verweisen, die eine Beziehung mit dem übergeordneten Element hat und für die übergeordnete Beziehungen herauszufinden sein müssen. |
Gibt zurück
- response
- array of AssetRelation
Auslöser
| Löst aus, wenn ein Ereignis für einen bereits registrierten Webhook auftritt |
Registriert einen Webhook für ein bestimmtes Ereignis und änderungstyp. Details finden Sie in GitHub-Dokumenten. |
Löst aus, wenn ein Ereignis für einen bereits registrierten Webhook auftritt
Registriert einen Webhook für ein bestimmtes Ereignis und änderungstyp. Details finden Sie in GitHub-Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Identitätswechselbenutzer
|
user_name | True | string |
Benutzername für den QPPNG-Benutzer, der als Identitätswechsel verwendet werden muss. |
|
Webhook-Name
|
name | True | string |
Eindeutiger Name zur Beschreibung des Zwecks und der Bedeutung von Webhooks. |
|
Webhook-Typ
|
type | True | string |
Beschreiben Sie den Webhook-Typ, der überwacht wird, z. B. "Ereignis" usw. |
|
Object
|
object | True | string |
Beschreibt den Typ des Objekts, das auf "Like ASSET" lauscht usw. |
|
Änderungstyp
|
changeType | True | array of string | |
|
Filterkriterien
|
filter | string |
Filterkriterien können definiert werden, um den Ereignistyp zu filtern. |
|
|
Verwendete Version
|
version | True | string |
Version, die als Webhook-Dienst in der QPPNG-Plattform verwendet wird. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Verwendete Version
|
version | string |
Version, die als Webhook-Dienst in der QPPNG-Plattform verwendet wird. |
|
Webhook-Typ
|
webhookInfo.type | string |
Beschreiben Sie den Webhook-Typ, der überwacht wird, z. B. "Ereignis" usw. |
|
Webhook-ID
|
webhookInfo.id | string |
Webhook-ID. |
|
Webhook-Name
|
webhookInfo.name | string |
Eindeutiger Name zur Beschreibung des Zwecks und der Bedeutung von Webhooks. |
|
AuxData
|
webhookInfo.auxData | string |
AuxData, falls vorhanden, während der Registrierung. |
Definitionen
PublishingOutputDownloadInfo
Definiert die Downloadinformationen für die Veröffentlichungsausgabe.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
attributesMap
|
attributesMap | object | |
|
Direkter Download
|
directDownload | boolean |
Definiert, ob direct Download zulässig ist. |
|
Download-URL
|
downloadUrl | string |
Stellt download-URL bereit, die mit der Download-BLOB-Aktion verwendet werden kann, um den Blob-Speicherort herunterzuladen. |
WebhookSuccessResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Definiert die ID für die Webhook-Erfolgsantwort. |
|
Der Status
|
status | string |
Definiert den Status der Webhook-Erfolgsantwort. |
|
Nachricht
|
message | string |
Definiert die Nachricht für die Webhook-Erfolgsantwort. |
|
Version
|
version | string |
Definiert die Version für die Webhook-Erfolgsantwort. |
AttributeValue
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Attribut-ID
|
attributeId | integer |
Definiert die Attribut-ID für das QPPNG-Attribut. |
|
Attributname
|
attributeName | string |
Definiert den Attributnamen für das QPPNG-Attribut. |
|
Typ
|
type | integer |
Definiert den Typ für das QPPNG-Attribut. |
|
Mehrwertigen
|
multiValued | boolean |
Definiert, ob das Attribut mehrwertige Werte aufweist. |
|
Wert
|
attributeValue | Value |
Wert. |
AssetUploadInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kontext-ID
|
contextId | string |
Definiert die Kontext-ID für den Ressourcenupload. |
|
URL hochladen
|
uploadUrl | string |
Definiert die Upload-URL für das Objekt. |
Vermögenswert
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Objekt-ID
|
assetId | integer |
Definiert die Objekt-ID für die QPPNG-Ressource. |
|
assetVersion
|
assetVersion | AssetVersion | |
|
attribute-Werte
|
attributeValues | array of AttributeValue |
Benutzer
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Benutzer-ID. |
|
Name
|
name | string |
Der Name des Benutzers. |
|
Domänen-ID
|
domainId | integer |
Domänen-ID des Benutzers. |
|
Quellreferenz
|
sourceReference | string |
Quellverweis für den Benutzer. |
|
Untergeordnete Domänenwerte
|
childDomainValues | array of DomainValue |
Array untergeordneter Domänenwerte. |
|
Hat Kinder
|
hasChildren | boolean |
Gibt an, ob der Benutzer untergeordnete Elemente hat. |
|
Ist gelöscht
|
isDeleted | boolean |
Gibt an, ob der Benutzer gelöscht wird. |
|
Ist Benutzer
|
user | boolean |
Gibt an, ob es sich bei der Entität um einen Benutzer handelt. |
|
LDAP-Profil-ID
|
ldapProfileId | integer |
LDAP-Profil-ID für den Benutzer. |
|
Standardbenutzerklassen-ID
|
defaultUserClassId | integer |
Standardbenutzerklassen-ID. |
|
E-Mail-Adresse
|
emailAddress | string |
E-Mail-Adresse des Benutzers. |
|
Ist gelöscht
|
deleted | boolean |
Gibt an, ob der Benutzer gelöscht wird. |
|
LDAP Distinguished Name
|
ldapDistinguishedName | string |
LDAP-Distinguished Name für den Benutzer. |
|
Native Trustee
|
nativeTrustee | boolean |
Gibt an, ob der Benutzer ein systemeigener Trustee ist. |
|
Vorname
|
firstName | string |
Vorname des Benutzers. |
|
Nachname
|
lastName | string |
Nachname des Benutzers. |
|
Rufnummer
|
phoneNumber | string |
Telefonnummer des Benutzers. |
|
Ist aktiviert
|
enabled | boolean |
Gibt an, ob der Benutzer aktiviert ist. |
|
Extern authentifiziert
|
externallyAuthenticated | boolean |
Gibt an, ob der Benutzer extern authentifiziert ist. |
|
Name für die Authentifizierung
|
nameForAuthentication | string |
Name für die Authentifizierung. |
ListResponseCollectionGroup
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
get_count | integer |
Die Anzahl der Elemente in der Antwort. |
|
Nächster Link
|
get_nextLink | string |
URL für den nächsten Ergebnissatz. |
|
Wert
|
get_value | array of CollectionGroup |
Array von Sammlungsgruppen. |
Wert
Wert.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
object |
Wert. |
AssetVersion
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Hauptversion
|
majorVersion | integer |
Hauptversion der Ressource. |
|
Nebenversion
|
minorVersion | integer |
Nebenversion der Ressource. |
|
Zweigstellenkennung
|
branchId | integer |
Verzweigungsversions-ID. |
|
Systemname
|
systemName | string |
Systemname für Objektversion. |
DomainValue
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Domänenwert-ID. |
|
Name
|
name | string |
Name des Domänenwerts. |
|
Domänen-ID
|
domainId | integer |
Domänen-ID des Domänenwerts. |
|
Quellreferenz
|
sourceReference | string |
Quellverweis des Domänenwerts. |
|
Untergeordnete Domänenwerte
|
childDomainValues | string |
Array untergeordneter Domänenwerte. |
|
Hat Kinder
|
hasChildren | boolean |
Gibt an, ob der Domänenwert untergeordnete Elemente aufweist. |
|
Ist gelöscht
|
isDeleted | boolean |
Gibt an, ob der Domänenwert gelöscht wird. |
CollectionGroup
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gruppen-ID
|
groupId | integer |
ID der Sammlungsgruppe. |
|
groupInfo
|
groupInfo | GroupInfo | |
|
Überschreiben der Benutzerklassen-ID
|
overriddenUserClassId | integer |
ID der überschriebenen Benutzerklasse. |
GroupInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Gruppen-ID. |
|
Name
|
name | string |
Name der Gruppe. |
|
Domänen-ID
|
domainId | integer |
Domänen-ID der Gruppe. |
|
Quellreferenz
|
sourceReference | string |
Quellverweis der Gruppe. |
|
Untergeordnete Domänenwerte
|
childDomainValues | array of DomainValue |
Array untergeordneter Domänenwerte. |
|
Hat Kinder
|
hasChildren | boolean |
Gibt an, ob die Gruppe untergeordnete Elemente enthält. |
|
Ist gelöscht
|
isDeleted | boolean |
Gibt an, ob die Gruppe gelöscht wird. |
|
Ist Benutzer
|
user | boolean |
Gibt an, ob die Gruppe einen Benutzer darstellt. |
|
LDAP-Profil-ID
|
ldapProfileId | integer |
LDAP-Profil-ID. |
|
Standardbenutzerklassen-ID
|
defaultUserClassId | integer |
ID der Standardbenutzerklasse. |
|
E-Mail-Adresse
|
emailAddress | string |
E-Mail-Adresse der Gruppe. |
|
Gelöscht
|
deleted | boolean |
Gibt an, ob die Gruppe gelöscht wird. |
|
LDAP Distinguished Name
|
ldapDistinguishedName | string |
LDAP distinguished name of the group. |
|
Native Trustee
|
nativeTrustee | boolean |
Gibt an, ob es sich bei der Gruppe um einen systemeigenen Trustee handelt. |
AssetDownloadInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kontext-ID
|
contextId | string |
ID des Kontexts. |
|
URL herunterladen
|
downloadUrl | string |
URL zum Herunterladen der Ressource. |
Arbeitsablauf
Details eines Workflows.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Eindeutiger Bezeichner für den Workflow. |
|
Name
|
name | string |
Name des Workflows. |
|
Domänen-ID
|
domainId | integer |
Bezeichner der Domäne, die dem Workflow zugeordnet ist. |
|
Quellreferenz
|
sourceReference | string |
Verweis, der der Quelle des Workflows zugeordnet ist. |
|
Untergeordnete Domänenwerte
|
childDomainValues | array of DomainValue |
Liste der untergeordneten Domänenwerte, die dem Workflow zugeordnet sind. |
|
Hat Kinder
|
hasChildren | boolean |
Gibt an, ob der Workflow untergeordnete Elemente hat. |
|
Ist gelöscht
|
isDeleted | boolean |
Gibt an, ob der Workflow als gelöscht markiert wurde. |
|
Status
|
statuses | array of Status |
Liste der Status im Workflow. |
|
Erstellt von
|
createdBy | integer |
Benutzer-ID des Erstellers des Workflows. |
|
Erstellt am
|
created | string |
Datum, an dem der Workflow erstellt wurde. |
|
Zuletzt geändert von
|
lastModifiedBy | integer |
Benutzer-ID des letzten Modifizierers des Workflows. |
|
Datum der letzten Änderung
|
lastModified | string |
Datum, an dem der Workflow zuletzt geändert wurde. |
|
Eingeschränkter Statusübergang
|
constrainedStatusTransition | boolean |
Definiert, ob der Statusübergang eingeschränkt ist. |
|
StatusRouting-Benutzerklassen
|
statusRoutingUserclasses | array of StatusRoutingUserClasses |
Liste der Statusrouting-Benutzerklassen. |
|
Statusübergänge
|
statusTransitions | array of StatusTransition |
Liste der Statusübergänge. |
Der Status
Stellt einen Status dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Eindeutiger Bezeichner für den Status. |
|
Name
|
name | string |
Name des Status. |
|
Domänen-ID
|
domainId | integer |
Domänenbezeichner für den Status. |
|
Quellreferenz
|
sourceReference | string |
Verweisen auf die Quelle des Status. |
|
Untergeordnete Domänenwerte
|
childDomainValues | array of DomainValue |
Array untergeordneter Domänenwerte. |
|
Hat Kinder
|
hasChildren | boolean |
Gibt an, ob der Status untergeordnete Status aufweist. |
|
Ist gelöscht
|
isDeleted | boolean |
Gibt an, ob der Status gelöscht wird. |
|
Workflow-ID
|
workflowId | integer |
ID des Workflows, der dem Status zugeordnet ist. |
|
Farbe Rot
|
colorRed | integer |
Rote Komponente der Statusfarbe. |
|
Farbe Grün
|
colorGreen | integer |
Grüne Komponente der Statusfarbe. |
|
Farbe Blau
|
colorBlue | integer |
Blaue Komponente der Statusfarbe. |
|
Position
|
position | integer |
Position des Status. |
StatusRoutingUserClasses
Zuordnung des Status zu Benutzerklassen für routing.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Status-ID
|
statusId | integer |
ID des Status für routing. |
|
Routing von Benutzerklassen-IDs
|
routingUserClassIds | array of integer |
Array von Benutzerklassen-IDs für routing. |
|
Benutzerklassenbasiertes Routing
|
userClassBasedRouting | boolean |
Gibt an, ob das klassenbasierte Routing des Benutzers aktiviert ist. |
StatusTransition
Details eines Statusübergangs innerhalb eines Workflows.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Status-ID
|
statusId | integer |
ID des Statusübergangs. |
|
Workflowinitiierungsstatus
|
workflowInitiatingStatus | boolean |
Gibt an, ob der Übergang vom Workflow initiiert wird. |
|
Nächste mögliche Status-IDs
|
nextPossibleStatusIds | array of integer |
IDs der nächsten möglichen Status nach diesem Übergang. |
AssetRelation
Details zu einer Beziehung zwischen Objekten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Eindeutige ID der Asset-Beziehung. |
|
Übergeordnete Objekt-ID
|
parentAssetId | integer |
DIE ID des übergeordneten Elements in der Beziehung. |
|
parentAssetVersion
|
parentAssetVersion | AssetVersion | |
|
Untergeordnete Objekt-ID
|
childAssetId | integer |
ID des untergeordneten Elements in der Beziehung. |
|
childAssetVersion
|
childAssetVersion | AssetVersion | |
|
Beziehungstyp-ID
|
relationTypeId | integer |
ID des Typs der Beziehung. |
|
Beziehungszustand
|
relationState | integer |
Zustand der Beziehung. |
|
Für untergeordnete Version gesperrt
|
lockedToChildVersion | boolean |
Flag, das angibt, ob die Beziehung auf die untergeordnete Version gesperrt ist. |
|
Auf aktuelle Version fixieren
|
freezeToCurrentVersion | boolean |
Flag, das angibt, ob die Beziehung auf die aktuelle Version fixiert ist. |
|
Relation-Attribute
|
relationAttributes | array of AttributeValue |
Attribute, die der Beziehung zugeordnet sind. |
Merkmal
Details eines Attributs, das einer Entität zugeordnet ist.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Eindeutige ID des Attributs. |
|
Name
|
name | string |
Name des Attributs. |
|
Werttyp
|
valueType | integer |
Typ des Werts, den das Attribut enthält. |
|
Benutzerdefiniert
|
userDefined | boolean |
Gibt an, ob das Attribut benutzerdefiniert ist. |
|
Queryable
|
queryable | boolean |
Gibt an, ob das Attribut abfragbar ist. |
|
Mehrwertige Werte
|
multiValued | boolean |
Gibt an, ob das Attribut mehrere Werte enthalten kann. |
|
Änderungsebene
|
modificationLevel | integer |
Änderungsebene des Attributs. |
|
Erstellt am
|
created | string |
Datum, an dem das Attribut erstellt wurde. |
|
Datum der letzten Änderung
|
lastModified | string |
Datum, an dem das Attribut zuletzt geändert wurde. |
|
Schöpfer
|
creator | integer |
ID des Benutzers, der das Attribut erstellt hat. |
|
Letzter Modifizierer
|
lastModifier | integer |
ID des Benutzers, der das Attribut zuletzt geändert hat. |
|
Ausgebbar
|
displayable | boolean |
Gibt an, ob das Attribut angezeigt werden kann. |
|
Eingeschränkter Zugriff
|
limitedAccess | boolean |
Gibt an, ob das Attribut eingeschränkten Zugriff hat. |
|
Eingeschränkter Zugriff kann geändert werden
|
limitedAccessChangeable | boolean |
Gibt an, ob die Einstellung für eingeschränkten Zugriff geändert werden kann. |
|
Einschränkungen können geändert werden
|
constraintsChangeable | boolean |
Gibt an, ob die Einschränkungen des Attributs geändert werden können. |
|
Werteinstellungen können geändert werden
|
valuePreferencesChangeable | boolean |
Gibt an, ob die Werteinstellungen geändert werden können. |
|
Boolesche Werteinstellungen
|
booleanValuePreferences | BooleanValuePreferences |
Einstellungen für boolesche Werte. |
|
Einstellungen für numerische Werte
|
numericValuePreferences | NumericValuePreferences |
Einstellungen für numerische Werte. |
|
Datumswerteinstellungen
|
dateValuePreferences | DateValuePreferences |
Einstellungen für Datumswerte. |
|
DateTime-Werteinstellungen
|
dateTimeValuePreferences | DateTimeValuePreferences |
Einstellungen für DateTime-Werte. |
|
Zeitwerteinstellungen
|
timeValuePreferences | TimeValuePreferences |
Einstellungen für Zeitwerte. |
|
Einstellungen für Messwert
|
measurementValuePreferences | MeasurementValuePreferences |
Einstellungen für Messwerte. |
|
Textwerteinstellungen
|
textValuePreferences | TextValuePreferences |
Einstellungen für Textwerte. |
|
Einstellungen für Domänenwertliste
|
domainValueListPreferences | DomainValueListPreferences |
Einstellungen für Domänenwertlisten. |
|
Domänenwerteinstellungen
|
domainValuePreferences | DomainValuePreferences |
Einstellungen für Domänenwerte. |
CreateAttributeSchema
Details eines Attributs, das einer Entität zugeordnet ist.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Eindeutige ID des Attributs. |
|
Name
|
name | string |
Name des Attributs. |
|
Werttyp
|
valueType | integer |
Typ des Werts, der das Attribut 1 für texttyp usw. enthält. |
|
Benutzerdefiniert
|
userDefined | boolean |
Gibt an, ob das Attribut benutzerdefiniert ist. |
|
Queryable
|
queryable | boolean |
Gibt an, ob das Attribut abfragbar ist. |
|
Mehrwertige Werte
|
multiValued | boolean |
Gibt an, ob das Attribut mehrere Werte enthalten kann. |
|
Änderungsebene
|
modificationLevel | integer |
Änderungsebene des Attributs. |
|
Erstellt am
|
created | string |
Datum, an dem das Attribut erstellt wurde. |
|
Datum der letzten Änderung
|
lastModified | string |
Datum, an dem das Attribut zuletzt geändert wurde. |
|
Schöpfer
|
creator | integer |
ID des Benutzers, der das Attribut erstellt hat. |
|
Letzter Modifizierer
|
lastModifier | integer |
ID des Benutzers, der das Attribut zuletzt geändert hat. |
|
Ausgebbar
|
displayable | boolean |
Gibt an, ob das Attribut angezeigt werden kann. |
|
Eingeschränkter Zugriff
|
limitedAccess | boolean |
Gibt an, ob das Attribut eingeschränkten Zugriff hat. |
|
Eingeschränkter Zugriff kann geändert werden
|
limitedAccessChangeable | boolean |
Gibt an, ob die Einstellung für eingeschränkten Zugriff geändert werden kann. |
|
Einschränkungen können geändert werden
|
constraintsChangeable | boolean |
Gibt an, ob die Einschränkungen des Attributs geändert werden können. |
|
Werteinstellungen können geändert werden
|
valuePreferencesChangeable | boolean |
Gibt an, ob die Werteinstellungen geändert werden können. |
|
Boolesche Werteinstellungen
|
booleanValuePreferences | BooleanValuePreferences |
Einstellungen für boolesche Werte. |
|
Einstellungen für numerische Werte
|
numericValuePreferences | NumericValuePreferences |
Einstellungen für numerische Werte. |
|
Datumswerteinstellungen
|
dateValuePreferences | DateValuePreferences |
Einstellungen für Datumswerte. |
|
DateTime-Werteinstellungen
|
dateTimeValuePreferences | DateTimeValuePreferences |
Einstellungen für DateTime-Werte. |
|
Zeitwerteinstellungen
|
timeValuePreferences | TimeValuePreferences |
Einstellungen für Zeitwerte. |
|
Einstellungen für Messwert
|
measurementValuePreferences | MeasurementValuePreferences |
Einstellungen für Messwerte. |
|
Textwerteinstellungen
|
textValuePreferences | TextValuePreferences |
Einstellungen für Textwerte. |
|
Einstellungen für Domänenwertliste
|
domainValueListPreferences | DomainValueListPreferences |
Einstellungen für Domänenwertlisten. |
|
Domänenwerteinstellungen
|
domainValuePreferences | DomainValuePreferences |
Einstellungen für Domänenwerte. |
ContentTypeInfo
Details eines Inhaltstyps.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Eindeutige ID des Inhaltstyps. |
|
Name
|
name | string |
Name des Inhaltstyps. |
|
Domänen-ID
|
domainId | integer |
Der Inhaltstyp zugeordnete Domänen-ID. |
|
Quellreferenz
|
sourceReference | string |
Verweis auf die Quelle des Inhaltstyps. |
|
Untergeordnete Domänenwerte
|
childDomainValues | array of DomainValue |
Liste der untergeordneten Domänenwerte, die dem Inhaltstyp zugeordnet sind. |
|
Hat Kinder
|
hasChildren | boolean |
Gibt an, ob der Inhaltstyp untergeordnete Elemente enthält. |
|
Ist gelöscht
|
isDeleted | boolean |
Gibt an, ob der Inhaltstyp gelöscht wird. |
|
Systemdefiniert
|
systemDefined | boolean |
Gibt an, ob der Inhaltstyp systemdefiniert ist. |
|
Kinder verfügbar
|
childrenAvailable | boolean |
Gibt an, ob untergeordnete Elemente für den Inhaltstyp verfügbar sind. |
|
Erweiterbar
|
extensible | boolean |
Gibt an, ob der Inhaltstyp erweiterbar ist. |
BooleanValuePreferences
Einstellungen für boolesche Werte.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Boolescher Wert
|
defaultValue | BooleanValue |
Boolescher Wert. |
BooleanValue
Boolescher Wert.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | boolean |
Der boolesche Wert. |
NumericValuePreferences
Einstellungen für numerische Werte.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Numerischer Wert
|
minimumPossibleValue | NumericValue |
Numerischer Wert. |
|
Numerischer Wert
|
maximumPossibleValue | NumericValue |
Numerischer Wert. |
|
Numerischer Wert
|
defaultValue | NumericValue |
Numerischer Wert. |
NumericValue
Numerischer Wert.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | integer |
Der numerische Wert. |
DateValue
Datumswert.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string |
Der Datumswert. |
DateValuePreferences
Einstellungen für Datumswerte.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datumswert
|
minimumPossibleValue | DateValue |
Datumswert. |
|
Datumswert
|
maximumPossibleValue | DateValue |
Datumswert. |
|
Datumswert
|
defaultValue | DateValue |
Datumswert. |
DateTimeValue
DateTime-Wert.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string |
Der DateTime-Wert. |
DateTimeValuePreferences
Einstellungen für DateTime-Werte.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
DateTime-Wert
|
minimumPossibleValue | DateTimeValue |
DateTime-Wert. |
|
DateTime-Wert
|
maximumPossibleValue | DateTimeValue |
DateTime-Wert. |
|
DateTime-Wert
|
defaultValue | DateTimeValue |
DateTime-Wert. |
TimeValue
Zeitwert.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string |
Der Zeitwert. |
TimeValuePreferences
Einstellungen für Zeitwerte.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zeitwert
|
minimumPossibleValue | TimeValue |
Zeitwert. |
|
Zeitwert
|
maximumPossibleValue | TimeValue |
Zeitwert. |
|
Zeitwert
|
defaultValue | TimeValue |
Zeitwert. |
MeasurementValue
Maßwert.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | double |
Der Messwert. |
MeasurementValuePreferences
Einstellungen für Messwerte.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Maßeinheit
|
measurementUnit | integer |
Maßeinheit. |
|
Nur Maßeinheit änderbar
|
onlyMeasurementUnitChangeable | boolean |
Gibt an, ob nur die Maßeinheit geändert werden kann. |
|
Messwert
|
minimumPossibleValue | MeasurementValue |
Maßwert. |
|
Messwert
|
maximumPossibleValue | MeasurementValue |
Maßwert. |
|
Messwert
|
defaultValue | MeasurementValue |
Maßwert. |
TextValue
Textwert
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | string |
Der Textwert. |
TextValuePreferences
Einstellungen für Textwerte.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Textwert
|
defaultValue | TextValue |
Textwert |
|
Max. Länge möglich
|
maxLengthPossible | integer |
Maximale mögliche Länge für Textwert. |
|
Textsuche aktiviert
|
textSearchEnabled | boolean |
Gibt an, ob die Textsuche aktiviert ist. |
DomainValueList
Liste der Domänenwerte.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Domänenwerte
|
domainValues | array of DomainValue |
Liste der Domänenwerte. |
DomainValueListPreferences
Einstellungen für Domänenwertlisten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Domänenwertliste
|
defaultValue | DomainValueList |
Liste der Domänenwerte. |
|
Domänen-ID
|
domainId | integer |
Der Domänenwertliste zugeordnete Domänen-ID. |
DomainValuePreferences
Einstellungen für Domänenwerte.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
defaultValue
|
defaultValue | DomainValue | |
|
Domänen-ID
|
domainId | integer |
Domänen-ID, die dem Domänenwert zugeordnet ist. |
QueryDefinition
Definition einer Abfrage.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Abfrage-ID
|
queryId | integer |
Eindeutige ID der Abfrage. |
|
Abfragename
|
queryName | string |
Name der Abfrage. |
|
Besitzer-ID
|
ownerId | integer |
ID des Abfragebesitzers. |
|
Parametriert
|
parameterized | boolean |
Gibt an, ob die Abfrage parametrisiert ist. |
|
Abfrageanzeige
|
queryDisplay | QueryDisplay |
Anzeigen von Einstellungen für eine Abfrage. |
|
Abfragebedingungen
|
queryConditions | array of QueryCondition |
Liste der Abfragebedingungen. |
|
Abfragekontext
|
queryContext | QueryContext |
Kontexteinstellungen für eine Abfrage. |
|
queryResults
|
queryResults |
QueryDisplay
Anzeigen von Einstellungen für eine Abfrage.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Spalten anzeigen
|
displayColumns | array of DisplayColumn |
Liste der Anzeigespalten. |
|
Sortieren
|
sorting | array of SortInfo |
Liste der Sortiereinstellungen. |
|
Anzeigemodus
|
displayMode | integer |
Einstellung des Anzeigemodus. |
|
Gruppierungsattribute
|
groupingAttributes | array of GroupingInfo |
Liste der Gruppierungsattribute. |
|
Erkunden des Modus
|
exploreMode | integer |
Moduseinstellung erkunden. |
QueryCondition
Bedingung für eine Abfrage.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Logischer Operator
|
logicalOperator | integer |
Logischer Operator für die Bedingung. |
|
Vergleichsoperator
|
comparisonOperator | integer |
Vergleichsoperator für die Bedingung. |
|
Negiert
|
negated | boolean |
Gibt an, ob die Bedingung negiert wird. |
|
Parametriert
|
parameterized | boolean |
Gibt an, ob die Bedingung parametrisiert ist. |
|
Typ
|
type | integer |
Typ der Bedingung. |
|
Attribut-ID
|
attributeId | integer |
Attribut-ID für suche. |
|
Wert für die Suche nach
|
value | string |
wert für "Suchen nach" aus. |
QueryContext
Kontexteinstellungen für eine Abfrage.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Inhaltstyp
|
contentType | integer |
ID des Inhaltstyps für den Abfragekontext. |
|
Auflistungen
|
collections | array of integer |
Liste der Sammlungs-IDs für den Abfragekontext. |
|
Rekursiv
|
recursive | boolean |
Gibt an, ob der Abfragekontext rekursiv ist. |
|
Alle Versionen einschließen
|
includeAllVersions | boolean |
Gibt an, ob alle Versionen im Abfragekontext enthalten sind. |
|
Filialen einschließen
|
includeBranches | boolean |
Gibt an, ob Verzweigungen im Abfragekontext enthalten sind. |
DisplayColumn
Spalte für die Anzeige in einer Abfrage.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Spalten-ID
|
columnId | integer |
ID der Anzeigespalte. |
|
Breite
|
width | integer |
Breite der Anzeigespalte. |
|
Attributspalte
|
attributeColumn | boolean |
Gibt an, ob es sich bei der Spalte um eine Attributspalte handelt. |
SortInfo
Sortiereinstellungen für eine Abfrage.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Spalten-ID
|
columnId | integer |
ID der Spalte zum Sortieren. |
|
Descending
|
descending | boolean |
Gibt an, ob die Sortierung in absteigender Reihenfolge liegt. |
|
Attributspalte
|
attributeColumn | boolean |
Gibt an, ob die sortierte Spalte eine Attributspalte ist. |
GroupingInfo
Gruppierungseinstellungen für eine Abfrage.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Attribut-ID
|
attributeId | integer |
ID des Attributs für die Gruppierung. |
|
Descending
|
descending | boolean |
Gibt an, ob sich die Gruppierung in absteigender Reihenfolge befindet. |
ListResponseQueryResultElement
Response-Element zum Auflisten von Abfrageergebnissen.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
get_count | integer |
Die Anzahl der Ergebnisse in der Listenantwort. |
|
Nächster Link
|
get_nextLink | string |
Link zur nächsten Ergebnisseite. |
|
Wert
|
get_value | array of QueryResultElement |
Array von Abfrageergebniselementen. |
QueryResultElement
Element in einem Abfrageergebnis.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Eindeutiger Bezeichner für das Element. |
|
Kind verfügbar
|
childAvailable | boolean |
Gibt an, ob untergeordnete Elemente verfügbar sind. |
|
Elementtyp
|
elementType | integer |
Typ des Elements. |
ListResponseUser
Response-Element zum Auflisten von Benutzern.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
get_count | integer |
Die Anzahl der Benutzer in der Listenantwort. |
|
Nächster Link
|
get_nextLink | string |
Link zur nächsten Ergebnisseite. |
|
Wert
|
get_value | array of User |
Array von Benutzerelementen. |
PublishingStatusInfo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
PublishingFailedException
|
publishingFailedException | PublishingFailedException |
Ausnahme ausgelöst, wenn die Veröffentlichung fehlschlägt |
|
publishingOutputDownloadInfo
|
publishingOutputDownloadInfo | array of PublishingOutputDownloadInfo | |
|
Veröffentlichungsstatus
|
publishingStatus | string |
Status der Veröffentlichung der Ressource, Mögliche Rückgabewerte sind PUBLISHING_IN_PROGESS, PUBLISHING_FAILED, PUBLISHING_COMPLETED |
PublishingFailedException
Ausnahme ausgelöst, wenn die Veröffentlichung fehlschlägt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zusatzinformation
|
additionalInfo | array of string |
Zusätzliche Informationen im Zusammenhang mit der Ausnahme |
|
Abwerfbar
|
cause | Throwable |
Basisklasse für Ausnahmen und Fehler |
|
Ausnahmecode
|
exceptionCode | string |
Code, der der Ausnahme zugeordnet ist |
|
Lokalisierte Nachricht
|
localizedMessage | string |
Lokalisierte Nachricht, die die Ausnahme beschreibt |
|
Nachricht
|
message | string |
Meldung zur Beschreibung der Ausnahme |
|
stackTrace
|
stackTrace | array of StackTraceElement | |
|
unterdrückt
|
suppressed | array of Throwable |
Abwerfbar
Basisklasse für Ausnahmen und Fehler
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ursache
|
cause | string |
Die Ursache der ausgelösten |
|
Lokalisierte Nachricht
|
localizedMessage | string |
Lokalisierte Nachricht, die die ausgelöste Nachricht beschreibt |
|
Nachricht
|
message | string |
Meldung zur Beschreibung des Auslösens |
|
stackTrace
|
stackTrace | array of StackTraceElement | |
|
Unterdrückt
|
suppressed | array of string |
Andere Throwables, die von diesem throwablen unterdrückt werden |
StackTraceElement
Ein Element, das einen einzelnen Stapelrahmen darstellt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Klassenname
|
className | string |
Name der Klasse, die den Ausführungspunkt enthält |
|
Dateiname
|
fileName | string |
Name der Datei, die den Ausführungspunkt enthält |
|
Zeilennummer
|
lineNumber | integer |
Zeilennummer in der Datei, die den Ausführungspunkt enthält |
|
Methodenname
|
methodName | string |
Name der Methode, die den Ausführungspunkt enthält |
|
Native-Methode
|
nativeMethod | boolean |
Gibt an, ob es sich bei der Methode um eine systemeigene Methode handelt. |
Gruppe
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
childDomainValues
|
childDomainValues | array of DomainValue | |
|
Standardbenutzerklassen-ID
|
defaultUserClassId | integer |
Die Standardbenutzerklassen-ID für die Gruppe. |
|
Gelöscht
|
deleted | boolean |
Gibt an, ob die Gruppe gelöscht wird. |
|
Domänen-ID
|
domainId | integer |
Die ID der Domäne, zu der die Gruppe gehört. |
|
E-Mail-Adresse
|
emailAddress | string |
Die E-Mail-Adresse, die der Gruppe zugeordnet ist. |
|
Hat Kinder
|
hasChildren | boolean |
Gibt an, ob die Gruppe untergeordnete Elemente hat. |
|
ID
|
id | integer |
Die ID der Gruppe. |
|
Ist gelöscht
|
isDeleted | boolean |
Gibt an, ob die Gruppe gelöscht wird. |
|
LDAP Distinguished Name
|
ldapDistinguishedName | string |
Der distinguished name in LDAP for the group. |
|
LDAP-Profil-ID
|
ldapProfileId | integer |
Die LDAP-Profil-ID für die Gruppe. |
|
Member-IDs
|
memberIds | array of integer |
Ein Array von Mitglieds-IDs, die der Gruppe zugeordnet sind. |
|
Name
|
name | string |
Der Name der Gruppe. |
|
Native Trustee
|
nativeTrustee | boolean |
Gibt an, ob es sich bei der Gruppe um einen systemeigenen Trustee handelt. |
|
Quellreferenz
|
sourceReference | string |
Der Quellverweis für die Gruppe. |
|
Benutzer
|
user | boolean |
Gibt an, ob die Gruppe ein Benutzer ist. |
Integer
Dies ist der grundlegende Datentyp "integer".
Schnur
Dies ist der grundlegende Datentyp "string".