Upland Panviva US (Vorschau)
Upland Panviva verbessert das Wissensmanagement für komplexe, regulierte Branchen, indem KI-gestützte, Echtzeit-Anleitungen für Agenten und Kunden bereitgestellt werden. Unsere Expertenlösungen sorgen für Compliance und Wettbewerbsfähigkeit, zugeschnitten auf Gesundheits-, Banken-, Versorgungs- und BPO-Organisationen mit großen Contact Centern. Von der complianceorientierten manuellen Verwaltung bis hin zur vollständig integrierten KI-Anleitung passt Sich Panviva ihren Anforderungen an. Steigern Sie die Produktivität und halten Sie Compliancestandards, die von branchenspezifischem Know-how unterstützt werden.
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 | Upland Panviva Support |
| URL | https://uplandsoftware.com/panviva/support/ |
| support@uplandsoftware.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Upland Software Inc.. |
| Webseite | https://uplandsoftware.com/panviva |
| Datenschutzrichtlinie | https://uplandsoftware.com/privacy |
| Kategorien | Daten; Marketing |
Panviva Connector
Upland Panviva verbessert das Wissensmanagement für komplexe, regulierte Branchen, indem KI-gestützte, Echtzeit-Anleitungen für Agenten und Kunden bereitgestellt werden. Unsere Expertenlösungen sorgen für Compliance und Wettbewerbsfähigkeit, zugeschnitten auf Gesundheits-, Banken-, Versorgungs- und BPO-Organisationen mit großen Contact Centern. Von der complianceorientierten manuellen Verwaltung bis hin zur vollständig integrierten KI-Anleitung passt Sich Panviva ihren Anforderungen an. Steigern Sie die Produktivität und halten Sie Compliancestandards, die von branchenspezifischem Know-how unterstützt werden.
Voraussetzungen
Sie benötigen Folgendes, um fortzufahren:
- Ein Microsoft Power Apps- oder Power Automate-Plan mit benutzerdefiniertem Connectorfeature
- Eine Panviva-Abonnementebene, die APIs enthält
Erstellen des Verbinders
Da die Panviva-APIs gesichert sind, benötigen Sie Folgendes:
- Zugriff auf eine Panviva-Instanz (auch bekannt als Mandant)
- Ein Entwicklerkonto im Panviva-Entwicklerportal US-[https://dev.panviva.com] AU-(https://dev.panviva.com)
- Ein aktives Panviva-API-Abonnement (auch bekannt als API-Plan) und gültige Panviva-API-Anmeldeinformationen
Nachdem dies abgeschlossen ist, können Sie den Connector erstellen und testen.
Unterstützte Aktionen
Der Panviva-Connector unterstützt die folgenden Aktionen:
-
Suchvorgänge
-
Search: Durchsuchen von Dokumenten, Ordnern und Dateien (externe Dokumente) nach einem Ausdruck und Zurückgeben von paginierten Ergebnissen -
Search Artefacts: Zurückgeben von Digital Orchestrator-Suchergebnissen für eine bestimmte Abfrage
-
-
Live-Vorgänge
-
Live CSH: Stellen Sie eine CSH-Suchergebnisseite der übergebenden Abfrage auf dem Panviva-Client für den angegebenen Benutzer auf dem Panviva-Client dar. -
Live Document: Präsentieren einer Dokumentseite für den angegebenen Benutzer auf dem Panviva-Client -
Live Search: Stellen Sie eine Suchergebnisseite der übergebenen Abfrage auf dem Panviva-Client für den angegebenen Benutzer auf dem Panviva-Client dar.
-
-
Dokumentvorgänge
-
Document: Zurückgeben eines Dokuments mithilfe der bereitgestellten Dokument-ID -
Document Containers: Zurückgeben einer Liste von Containern mithilfe der bereitgestellten Dokument-ID -
Document Container Relationships: Zurückgeben einer Liste der Beziehungen zwischen den übergeordneten und untergeordneten Elementen zwischen jedem Container für die bereitgestellte Dokument-ID -
Container: Zurückgeben eines Containers mithilfe der bereitgestellten Container-ID -
Document Translations: Zurückgeben einer Liste aller Übersetzungen (pro Sprache und Gebietsschema) eines Panviva-Dokuments
-
-
Ressourcenvorgänge
-
Artefact: Zurückgeben eines Digital Orchestrator-Artefakts mithilfe der bereitgestellten ID -
Get Artefact Categories: Ruft eine Liste aller verfügbaren Artefaktkategorien ab. -
File: Abrufen einer Datei (externes Dokument) aus Panviva -
Folder: Zurückgeben von Informationen zu einem Panviva-Ordner und Verweisen auf jedes seiner direkten untergeordneten Elemente -
Folder Children: Ruft alle unmittelbaren untergeordneten Elemente eines Panviva-Ordners ab, nicht einschließlich Enkelkindern. Untergeordnete Elemente können Ordner, Dokumente oder Dateien (externe Dokumente) sein. -
Folder Translations: Ruft alle Übersetzungen eines Panviva-Ordners zusammen mit den einzelnen übersetzten Ordnern ab. -
Folder Root: Ruft den Stamm-/Startordner in allen Panviva ab, der mithilfe des Endpunkts "Ordner untergeordnete Ordner abrufen" drilled werden kann. Beachten Sie, dass dieser Endpunkt früher als Endpunkt "Ordnersuche" bezeichnet wurde. -
Image: Gibt ein Bild von Panviva zurück. Bilddaten werden als base64-Zeichenfolge dargestellt.
-
-
Erstellen von Vorgängen
-
Publish Artefact: Aktualisiert ein bereits veröffentlichtes Digital Orchestrator-Artefakt -
Create Artefact Category: Erstellt eine Kategorie zum Klassifizieren von Digital Orchestrator-Artefakten -
Create Artefact: Erstellt ein neues Digital Orchestrator-Artefakt
-
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 |
|---|---|---|---|
| API-Schlüssel | securestring | Die api_key für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Artefakt |
Zurückgeben eines Digital Orchestrator-Artefakts mithilfe der bereitgestellten ID. |
| Artefakt erstellen |
Erstellt ein neues Digital Orchestrator-Artefakt mit Inhalten, Metadaten und Kategorieinformationen. Artefakte sind wiederverwendbare Inhaltsteile, die über verschiedene Kanäle innerhalb von Panviva geliefert werden können. |
| Artefakt veröffentlichen |
Aktualisiert ein vorhandenes Digital Orchestrator-Artefakt mit neuen Inhalten, Metadaten oder Kategorieinformationen. Dieser Vorgang wird verwendet, um Artefakte zu ändern, die bereits veröffentlicht wurden. |
| Artefakte suchen |
Gibt Die Suchergebnisse von Digital Orchestrator für eine bestimmte natürliche Sprache oder erweiterte Abfrage zurück. Dieser Endpunkt ermöglicht das Durchsuchen von Artefakten mithilfe verschiedener Abfragemethoden und Filteroptionen. |
| Artefaktkategorie abrufen |
Ruft eine Liste aller verfügbaren Kategorien zum Klassifizieren von Digital Orchestrator-Artefakten ab. Diese Kategorien helfen beim Organisieren von Artefakten und können zum Filtern und Navigieren verwendet werden. |
| Artefaktkategorie erstellen |
Erstellt eine neue Kategorie zum Klassifizieren von Digital Orchestrator-Artefakten. Kategorien helfen beim Organisieren von Artefakten nach Thema, Abteilung oder einem anderen klassifizierungssystem, das für Ihre Organisation relevant ist. |
| Bild |
Ruft ein bestimmtes Bild ab, das in Panviva gespeichert ist. Die Bilddaten werden als base64-codierte Zeichenfolge zurückgegeben, die in Anwendungen decodiert und angezeigt oder als Bilddatei gespeichert werden kann. |
| Container |
Zurückgeben eines Dokumentcontainers mithilfe der bereitgestellten Container-ID. |
| Datei |
Ruft ein externes Dokument (z. B. ein PDF-, Word-Dokument oder einen anderen Dateityp) ab, das in Panviva hochgeladen wurde. Der Dateiinhalt wird als base64-codierte Zeichenfolge zurückgegeben. |
| Dokument |
Zurückgeben eines Dokuments mithilfe der bereitgestellten Dokument-ID. |
| Dokumentcontainer |
Ruft alle Container (Abschnitte und Unterabschnitte) in einem angegebenen Dokument ab. Container stellen die hierarchische Struktur von Inhalten innerhalb eines Dokuments dar. |
| Dokumentcontainerbeziehungen |
Ruft die hierarchische Struktur eines Dokuments ab, indem die Beziehungen zwischen allen Containern (Abschnitten und Unterabschnitten) innerhalb des Dokuments zurückgegeben werden. Dies hilft ihnen zu verstehen, wie Inhalte organisiert werden. |
| Dokumentübersetzungen |
Ruft alle verfügbaren Übersetzungen eines Panviva-Dokuments in verschiedenen Sprachen und Gebietsschemas ab. Auf diese Weise können Sie auf mehrsprachige Versionen desselben Inhalts zugreifen. |
| Echo |
Echo eine Anforderung zur Überprüfung der Konnektivität mit der Panviva-API. Dieser Endpunkt ist nützlich für Test- und Debuggingzwecke. |
| Live CSH |
Stellt eine kontextabhängige Hilfeseite (CSH) einem angegebenen Benutzer in ihrem Panviva-Client dar. Mit diesem Vorgang können Sie Suchergebnisse direkt auf den Bildschirm eines Benutzers übertragen. |
| Live-Suche |
Stellen Sie eine Suchergebnisseite der übergebenden Abfrage auf dem Panviva-Client für den angegebenen Benutzer auf dem Panviva-Client in Echtzeit dar. |
| Livedokument |
Verschiebt einen bestimmten Dokument- oder Dokumentabschnitt direkt an den Panviva-Client eines bestimmten Benutzers. Auf diese Weise können Sie relevante Dokumentationen für Benutzer während der Arbeit in Echtzeit anzeigen. |
| Ordner |
Ruft Informationen zu einem bestimmten Panviva-Ordner ab, einschließlich seiner Metadaten und Links zu den direkten untergeordneten Elementen. Ordner werden verwendet, um Dokumente und Dateien in einer hierarchischen Struktur zu organisieren. |
| Ordnerstamm |
Ruft den Startordner der obersten Ebene in Panviva ab, der als Ausgangspunkt für die Navigation in der gesamten Inhaltshierarchie dient. Dieser Stammordner enthält Links zu den direkten untergeordneten Elementen, auf die über den Endpunkt "Ordner untergeordnete Elemente abrufen" zugegriffen werden kann, um die Ordnerstruktur zu durchlaufen. |
| Ordnerübersetzungen |
Ruft alle verfügbaren Übersetzungen eines bestimmten Panviva-Ordners in verschiedenen Sprachen und Gebietsschemas ab. Dazu gehören Metadaten für jede übersetzte Version des Ordners und Links für den Zugriff auf die jeweiligen untergeordneten Elemente. |
| Suche |
Durchsucht Dokumente, Ordner und Dateien (externe Dokumente) nach einem Ausdruck und gibt paginierte Ergebnisse zurück. |
| Untergeordnete Ordner |
Ruft alle unmittelbaren untergeordneten Elemente (direkte Inhalte) eines bestimmten Panviva-Ordners ab. Dazu gehören Unterordner, Dokumente und Dateien (externe Dokumente), die direkt im angegebenen Ordner enthalten sind, aber keine Elemente in geschachtelten Unterordnern enthalten sind. |
Artefakt
Zurückgeben eines Digital Orchestrator-Artefakts mithilfe der bereitgestellten ID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Artefakt-ID
|
id | True | string |
Format - uuid. Die ID (ID) des Digital Orchestrator-Artefakts. |
Gibt zurück
Die Antwort der Panviva-API mit erweiterten Antwortdaten.
Artefakt erstellen
Erstellt ein neues Digital Orchestrator-Artefakt mit Inhalten, Metadaten und Kategorieinformationen. Artefakte sind wiederverwendbare Inhaltsteile, die über verschiedene Kanäle innerhalb von Panviva geliefert werden können.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Als Entwurf speichern
|
isDraft | boolean |
Gibt an, ob das Artefakt als Entwurf (true) gespeichert oder sofort veröffentlicht werden soll (false). Entwürfe von Artefakten sind für Endbenutzer erst sichtbar, wenn sie veröffentlicht wurden. |
|
|
title
|
title | string |
Der Titel des zu erstellenden Artefakts. |
|
|
mediaType
|
mediaType | string |
Der MIME-Typ des Inhalts in diesem Abschnitt (z. B. Text/Nur-Text, Bild/JPEG). |
|
|
Text
|
text | string |
Der Textinhalt für diesen Abschnitt, falls zutreffend. |
|
|
source
|
source | string |
Der Quellverweis für diesen Inhalt, wenn er aus externem Material stammt. |
|
|
resourceLocation
|
resourceLocation | string |
Gibt an, ob die Ressource intern oder extern gespeichert wird (Werte: intern, extern, null). |
|
|
mediaType
|
mediaType | string |
Der Medientyp des Inhalts (z. B. "text/html", "text/plain"). |
|
|
Text
|
text | string |
Der Textinhalt des Abschnitts. |
|
|
href
|
href | string |
Ein Link zu zusätzlichen Inhalten oder Ressourcen. |
|
|
resourceLocation
|
resourceLocation | string |
Der Speicherort der Ressource, in der Regel eine URL oder ein Dateipfad. |
|
|
id
|
id | integer |
Der eindeutige Bezeichner für den Kanal. |
|
|
name
|
name | string |
Der Name des Kanals für die Inhaltsübermittlung. |
|
|
id
|
id | integer |
Der eindeutige Bezeichner der Kategorie, die dem Artefakt zugeordnet werden soll. |
|
|
primaryQuery
|
primaryQuery | string |
Der Hauptabfragetext, den dieses Artefakt beantworten soll. |
|
|
Anfrage
|
query | string |
Der Suchabfragetext. |
|
|
panvivaDocumentId
|
panvivaDocumentId | integer |
Die ID eines verwandten Panviva-Dokuments, wenn dieses Artefakt mit einem verknüpft ist. |
|
|
panvivaDocumentVersion
|
panvivaDocumentVersion | integer |
Die Version des zugehörigen Panviva-Dokuments. |
|
|
Metadaten
|
metaData | object |
Gibt zurück
Die Antwort der Panviva-API nach der Erstellung eines neuen Artefakts.
- Body
- PostArtefactResponse
Artefakt veröffentlichen
Aktualisiert ein vorhandenes Digital Orchestrator-Artefakt mit neuen Inhalten, Metadaten oder Kategorieinformationen. Dieser Vorgang wird verwendet, um Artefakte zu ändern, die bereits veröffentlicht wurden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Artefakt-ID
|
id | True | string |
Der eindeutige Bezeichner (UUID-Format) des zu aktualisierenden Artefakts. |
|
id
|
id | uuid |
Der eindeutige Bezeichner des Artefakts, der aktualisiert werden soll. |
|
|
primaryResponse
|
primaryResponse | string |
Der primäre Antwortinhalt für das Artefakt. |
|
|
panvivaDocumentVersion
|
panvivaDocumentVersion | integer |
Die Versionsnummer des Panviva-Dokuments, das diesem Artefakt zugeordnet ist. |
|
|
mediaType
|
mediaType | string |
Der MIME-Typ des Inhalts in diesem Abschnitt (z. B. Text/Nur-Text, Bild/JPEG). |
|
|
Text
|
text | string |
Der Textinhalt für diesen Abschnitt, falls zutreffend. |
|
|
source
|
source | string |
Der Quellverweis für diesen Inhalt, wenn er aus externem Material stammt. |
|
|
resourceLocation
|
resourceLocation | string |
Gibt an, ob die Ressource intern oder extern gespeichert wird (Werte: intern, extern, null). |
|
|
sectionId
|
sectionId | string |
Der eindeutige Bezeichner des markierten Abschnitts. |
|
|
hash
|
hash | string |
Ein Hashwert, der den Inhalt des markierten Abschnitts darstellt. |
|
|
id
|
id | integer |
Der eindeutige Bezeichner der Kategorie, die dem Artefakt zugeordnet werden soll. |
|
|
panvivaDocumentId
|
panvivaDocumentId | string |
Die ID des Panviva-Dokuments, das diesem Artefakt zugeordnet ist. |
|
|
title
|
title | string |
Der Titel des Artefakts. |
|
|
primaryQuery
|
primaryQuery | string |
Der Hauptabfragetext, den dieses Artefakt beantworten soll. |
|
|
id
|
id | integer | ||
|
Anfrage
|
query | string |
Der Suchabfragetext. |
|
|
Metadaten
|
metaData | object | ||
|
id
|
id | integer |
Der eindeutige Bezeichner für die Variation. |
|
|
id
|
id | integer |
Der eindeutige Bezeichner für den Kanal. |
|
|
name
|
name | string |
Der Name des Kanals für die Inhaltsübermittlung. |
|
|
Inhalt
|
content | string |
Der Inhalt der Variation, in der Regel im HTML-Format. |
Gibt zurück
Die Antwort der Panviva-API nach der Aktualisierung eines Artefakts.
- Body
- PutArtefactResponse
Artefakte suchen
Gibt Die Suchergebnisse von Digital Orchestrator für eine bestimmte natürliche Sprache oder erweiterte Abfrage zurück. Dieser Endpunkt ermöglicht das Durchsuchen von Artefakten mithilfe verschiedener Abfragemethoden und Filteroptionen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Einfache Abfrage
|
simplequery | string |
Abfragezeichenfolge für natürliche Sprache. Beispiel: "Welche Actionfilmstars Peter Parker?" (Hinweis: Verwenden Sie simplequery ODER advancedquery, nicht beide.) |
|
|
Erweiterte Abfrage
|
advancedquery | string |
Abfragezeichenfolge, die in der Abfragesyntax Lucene geschrieben wurde. Beispiel: 'Filme UND 'eine Geschichte'. (Hinweis: Verwenden Sie simplequery ODER advancedquery, nicht beide.) |
|
|
Filter
|
filter | string |
Akzeptiert eine in der OData-Ausdruckssyntax geschriebene Filterzeichenfolge. Beispiele: |
|
|
Kanal
|
channel | string |
Antwort für einen bestimmten Kanal anstelle der Standardeinstellung zurückgeben. |
|
|
Seitenoffset
|
pageOffset | integer |
Der Paginierungsoffset, um die Anzahl der zu überspringenden anfänglichen Suchergebnisse anzuzeigen. |
|
|
Seitenlimit
|
pageLimit | integer |
Die Anzahl der zurückzugebenden Datensätze. Muss eine ganze Zahl zwischen 0 und 1000 sein. |
|
|
Facetzeichenfolge
|
facet | string |
Akzeptiert eine Zeichenfolge, die das Feld angibt, nach dem facet werden soll. Beispiele: |
|
|
Markierungen hervorheben
|
highlightTags | string |
Akzeptiert Vor- und Beitragstags in der Vorlage [Starttag,Endtag]. Beispiel: |
Gibt zurück
Die Antwort der Panviva-API mit erweiterten Suchartefaktedaten.
Artefaktkategorie abrufen
Ruft eine Liste aller verfügbaren Kategorien zum Klassifizieren von Digital Orchestrator-Artefakten ab. Diese Kategorien helfen beim Organisieren von Artefakten und können zum Filtern und Navigieren verwendet werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
Gibt zurück
Die Antwort der Panviva-API, die Artefaktkategoriendaten enthält.
Artefaktkategorie erstellen
Erstellt eine neue Kategorie zum Klassifizieren von Digital Orchestrator-Artefakten. Kategorien helfen beim Organisieren von Artefakten nach Thema, Abteilung oder einem anderen klassifizierungssystem, das für Ihre Organisation relevant ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
name
|
name | string |
Der Name der Artefaktkategorie, die erstellt werden soll. |
Gibt zurück
Die Antwort der Panviva-API nach der Erstellung einer neuen Artefaktkategorie.
Bild
Ruft ein bestimmtes Bild ab, das in Panviva gespeichert ist. Die Bilddaten werden als base64-codierte Zeichenfolge zurückgegeben, die in Anwendungen decodiert und angezeigt oder als Bilddatei gespeichert werden kann.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Bild-ID
|
id | True | integer |
Der eindeutige Bezeichner des abzurufenden Panviva-Bilds. |
Gibt zurück
Die Antwort der Panviva-API, die Bilddaten enthält.
- Body
- GetImageResponse
Container
Zurückgeben eines Dokumentcontainers mithilfe der bereitgestellten Container-ID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Container-ID
|
id | True | string |
Die ID eines Dokumentcontainers. |
Gibt zurück
Die Antwort der Panviva-API, die Containerdaten enthält.
- Body
- GetContainerResponse
Datei
Ruft ein externes Dokument (z. B. ein PDF-, Word-Dokument oder einen anderen Dateityp) ab, das in Panviva hochgeladen wurde. Der Dateiinhalt wird als base64-codierte Zeichenfolge zurückgegeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Datei-ID
|
id | True | integer |
Die interne ID (IID) der abzurufenden Panviva-Datei (externes Dokument). |
Gibt zurück
Die Antwort der Panviva-API, die Dateidaten enthält.
- Body
- GetFileResponse
Dokument
Zurückgeben eines Dokuments mithilfe der bereitgestellten Dokument-ID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Dokument-ID
|
id | True | string |
Ein eindeutiger Dokumentbezeichner, Dokument-ID. Wenn ein Dokument ein übersetztes Dokument ist, stellt dieser Wert die interne ID oder IID in der Panviva-API v1 dar. |
|
Dokumentversion
|
version | integer |
Fordern Sie die API an, eine bestimmte Version des angegebenen Dokuments zurückzugeben. |
Gibt zurück
Die Antwort der Panviva-API, die Dokumentdaten enthält.
- Body
- GetDocumentResponse
Dokumentcontainer
Ruft alle Container (Abschnitte und Unterabschnitte) in einem angegebenen Dokument ab. Container stellen die hierarchische Struktur von Inhalten innerhalb eines Dokuments dar.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Dokument-ID
|
id | True | integer |
Die interne ID (IID) des Panviva-Dokuments, dessen Container Sie abrufen möchten. |
|
Dokumentversion
|
version | integer |
Die spezifische Version des Dokuments, deren Container Sie abrufen möchten. Wenn dies nicht angegeben wird, werden die Container der neuesten Version zurückgegeben. |
Gibt zurück
Die Antwort der Panviva-API, die Dokumentcontainerdaten enthält.
Dokumentcontainerbeziehungen
Ruft die hierarchische Struktur eines Dokuments ab, indem die Beziehungen zwischen allen Containern (Abschnitten und Unterabschnitten) innerhalb des Dokuments zurückgegeben werden. Dies hilft ihnen zu verstehen, wie Inhalte organisiert werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Dokument-ID
|
id | True | integer |
Die interne ID (IID) des Panviva-Dokuments, dessen Struktur Sie abrufen möchten. |
Gibt zurück
Die Antwort der Panviva-API, die Dokumentcontainerbeziehungen enthält.
Dokumentübersetzungen
Ruft alle verfügbaren Übersetzungen eines Panviva-Dokuments in verschiedenen Sprachen und Gebietsschemas ab. Auf diese Weise können Sie auf mehrsprachige Versionen desselben Inhalts zugreifen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Dokument-ID
|
id | True | integer |
Die interne ID (IID) des ursprünglichen Panviva-Dokuments, für das Sie Übersetzungen abrufen möchten. |
Gibt zurück
Die Antwort der Panviva-API, die Dokumentübersetzungsdaten enthält.
Echo
Echo eine Anforderung zur Überprüfung der Konnektivität mit der Panviva-API. Dieser Endpunkt ist nützlich für Test- und Debuggingzwecke.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
Live CSH
Stellt eine kontextabhängige Hilfeseite (CSH) einem angegebenen Benutzer in ihrem Panviva-Client dar. Mit diesem Vorgang können Sie Suchergebnisse direkt auf den Bildschirm eines Benutzers übertragen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
username
|
username | string |
Der Panviva-Benutzer, an den Sie das Ergebnis senden möchten. (Hinweis: Verwenden Sie benutzernamen ODER userId, nicht beide.) |
|
|
userId
|
userId | string |
Die numerische ID des Benutzers, an den Sie das Ergebnis senden möchten. (Hinweis: Verwenden Sie benutzernamen ODER userId, nicht beide.) |
|
|
Anfrage
|
query | string |
Der csH-Begriff, nach dem gesucht werden soll. |
|
|
showFirstResult
|
showFirstResult | boolean |
True, um das erste gefundene Dokument sofort zu öffnen, oder false, um die Liste der Ergebnisse anzuzeigen. |
|
|
maximizeClient
|
maximizeClient | boolean |
True/False, je nachdem, ob der Panviva-Client auf dem Desktop des Benutzers maximiert werden soll, wenn das Dokument übermittelt wird. |
Gibt zurück
Die Antwort der Panviva-API nach dem Senden einer Live-CSH-Anforderung.
- response
- object
Live-Suche
Stellen Sie eine Suchergebnisseite der übergebenden Abfrage auf dem Panviva-Client für den angegebenen Benutzer auf dem Panviva-Client in Echtzeit dar.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
username
|
username | string |
Der Panviva-Benutzer, an den Sie das Ergebnis senden möchten. (Hinweis: Verwenden Sie benutzernamen ODER userId, nicht beide.) |
|
|
userId
|
userId | string |
Die numerische ID des Benutzers, an den Sie das Ergebnis senden möchten. (Hinweis: Verwenden Sie benutzernamen ODER userId, nicht beide.) |
|
|
Anfrage
|
query | string |
Der zu suchde Begriff. |
|
|
maximizeClient
|
maximizeClient | boolean |
True/False, je nachdem, ob der Panviva-Client auf dem Desktop des Benutzers maximiert werden soll, wenn das Dokument übermittelt wird. |
|
|
showFirstResult
|
showFirstResult | boolean |
True, um das erste gefundene Dokument sofort zu öffnen, oder false, um die Liste der Ergebnisse anzuzeigen. |
Gibt zurück
Die Antwort der Panviva-API nach dem Senden einer Live-Suchanfrage.
- response
- object
Livedokument
Verschiebt einen bestimmten Dokument- oder Dokumentabschnitt direkt an den Panviva-Client eines bestimmten Benutzers. Auf diese Weise können Sie relevante Dokumentationen für Benutzer während der Arbeit in Echtzeit anzeigen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
username
|
username | string |
Der Panviva-Benutzer, an den Sie das Ergebnis senden möchten. (Hinweis: Verwenden Sie benutzernamen ODER userId, nicht beide.) |
|
|
userId
|
userId | string |
Die numerische ID des Benutzers, an den Sie das Ergebnis senden möchten. (Hinweis: Verwenden Sie benutzernamen ODER userId, nicht beide.) |
|
|
id
|
id | string |
Die Dokument-ID des Panviva-Dokuments, das Sie senden möchten. |
|
|
location
|
location | string |
Die Abschnitts-ID, die dem Benutzer angezeigt werden soll. Hinweis: Verwenden Sie location OR containerId, nicht beide.) |
|
|
maximizeClient
|
maximizeClient | boolean |
True/False, je nachdem, ob der Panviva-Client auf dem Desktop des Benutzers maximiert werden soll, wenn das Dokument übermittelt wird. |
|
|
Container-ID
|
containerId | string |
Die ID des Containers, den der Benutzer sehen soll, wenn das angegebene Dokument geöffnet wird. (Hinweis: Verwenden Sie den Speicherort ODER containerId, nicht beide.) |
Gibt zurück
Die Antwort der Panviva-API nach dem Senden einer Livedokumentanforderung.
- response
- object
Ordner
Ruft Informationen zu einem bestimmten Panviva-Ordner ab, einschließlich seiner Metadaten und Links zu den direkten untergeordneten Elementen. Ordner werden verwendet, um Dokumente und Dateien in einer hierarchischen Struktur zu organisieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Ordner-ID
|
id | True | integer |
Die interne ID (IID) des abzurufenden Panviva-Ordners. |
Gibt zurück
Die Antwort der Panviva-API, die Ordnerdaten enthält.
- Body
- GetFolderResponse
Ordnerstamm
Ruft den Startordner der obersten Ebene in Panviva ab, der als Ausgangspunkt für die Navigation in der gesamten Inhaltshierarchie dient. Dieser Stammordner enthält Links zu den direkten untergeordneten Elementen, auf die über den Endpunkt "Ordner untergeordnete Elemente abrufen" zugegriffen werden kann, um die Ordnerstruktur zu durchlaufen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
Gibt zurück
Die Antwort der Panviva-API, die Stammordnerdaten enthält.
Ordnerübersetzungen
Ruft alle verfügbaren Übersetzungen eines bestimmten Panviva-Ordners in verschiedenen Sprachen und Gebietsschemas ab. Dazu gehören Metadaten für jede übersetzte Version des Ordners und Links für den Zugriff auf die jeweiligen untergeordneten Elemente.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Ordner-ID
|
id | True | integer |
Die interne ID (IID) des ursprünglichen Panviva-Ordners, für den Sie Übersetzungen abrufen möchten. |
Gibt zurück
Die Antwort der Panviva-API, die Ordnerübersetzungsdaten enthält.
Suche
Durchsucht Dokumente, Ordner und Dateien (externe Dokumente) nach einem Ausdruck und gibt paginierte Ergebnisse zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Suchbegriff
|
term | True | string |
Das Wort oder der Ausdruck, nach dem gesucht werden soll. Unterstützt einfache Schlüsselwörter, Lucene-Syntax und Regex-Muster. |
|
Seitenoffset
|
pageOffset | integer |
Der Paginierungsoffset, um die Anzahl der zu überspringenden anfänglichen Suchergebnisse anzuzeigen. |
|
|
Seitenlimit
|
pageLimit | integer |
Die Anzahl der zurückzugebenden Datensätze. Muss eine ganze Zahl zwischen 0 und 1000 sein. |
|
|
Geändert bei
|
changedWhen | string |
Hilfsstichwörter zum Anwenden von Filtern für Dokumente, die im Bereich aktualisiert wurden. |
|
|
Direkte übergeordnete Ordner-ID
|
directParentFolderId | integer |
Suchen Sie nur innerhalb eines bestimmten Ordners. Alle Dokumente in den Unterordnern werden nicht durchsucht. Wenn nicht angegeben, werden Ressourcen in allen Ordnern durchsucht. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
results
|
results | array of object |
Die Liste der Ressourcen, die den Suchkriterien entsprechen. |
|
type
|
results.type | string |
Der Typ der zurückgegebenen Ressource (z. B. "Dokument", "Ordner" oder "Datei"). |
|
id
|
results.id | string |
Der eindeutige Bezeichner für die Ressource, die zum Abrufen seiner Details verwendet werden kann. |
|
name
|
results.name | string |
Der Titel oder der Anzeigename der Ressource. |
|
Layout
|
results.layout | string |
Die für die Ressource verwendete Seitenlayoutvorlage (z. B. "topTabsMedium", "leftTabsMedium"). |
|
Beschreibung
|
results.description | string |
Eine kurze Zusammenfassung oder Beschreibung des Inhalts der Ressource. |
|
classification
|
results.classification | string |
Die Kategorie oder Klassifizierung der Ressource (z. B. "Filme", "Bücher"). |
|
updatedDate
|
results.updatedDate | string |
Das Datum, an dem die Ressource zuletzt aktualisiert wurde, im ISO 8601-Format (JJJJ-MM-DD). |
|
matchedFields
|
results.matchedFields | array of string |
Die Liste der Felder, in denen der Suchbegriff gefunden wurde (z. B. "Name", "Inhalt"). |
|
Schnipsel
|
results.snippet | string |
Ein kurzer Auszug aus dem Inhalt, der den Suchbegriff im Kontext anzeigt, häufig mit Hervorhebung. |
|
language
|
results.language | string |
Der Sprachcode der Ressource (z. B. "en-AU" für Australisches Englisch). |
|
Verknüpfungen
|
results.links | array of object |
Hypermedia-Links im Zusammenhang mit diesem Suchergebnis, die für weitere Vorgänge verwendet werden können. |
|
href
|
results.links.href | string |
Die URL für den Zugriff auf die zugehörige Ressource oder Ausführen eines Vorgangs. |
|
rel
|
results.links.rel | string |
Der Beziehungstyp der Verknüpfung mit der aktuellen Ressource (z. B. "Dokument", "Datei"). |
|
type
|
results.links.type | string |
Die HTTP-Methode, die beim Zugriff auf diesen Link verwendet werden soll (in der Regel 'GET'). |
|
gesamt
|
total | integer |
Die Gesamtanzahl der Ergebnisse, die den Suchkriterien auf allen Seiten entsprechen. |
|
Verknüpfungen
|
links | array of object |
Paginierungslinks, die die Navigation zwischen Seiten von Suchergebnissen ermöglichen. |
|
href
|
links.href | string |
Die URL für den Zugriff auf eine bestimmte Seite mit Suchergebnissen. |
|
rel
|
links.rel | string |
Die Beziehung dieses Links zur aktuellen Seite (z. B. "first", "last", "next", "prev"). |
|
type
|
links.type | string |
Die HTTP-Methode, die beim Zugriff auf diesen Link verwendet werden soll (in der Regel 'GET'). |
Untergeordnete Ordner
Ruft alle unmittelbaren untergeordneten Elemente (direkte Inhalte) eines bestimmten Panviva-Ordners ab. Dazu gehören Unterordner, Dokumente und Dateien (externe Dokumente), die direkt im angegebenen Ordner enthalten sind, aber keine Elemente in geschachtelten Unterordnern enthalten sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instanzname
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Ordner-ID
|
id | True | integer |
Die interne ID (IID) des Panviva-Ordners, deren Inhalt Sie abrufen möchten. |
Gibt zurück
Die Antwort der Panviva-API, die Ordner-untergeordnete Daten enthält.
Definitionen
ArtefaktKategory
Eine Kategorie im Panviva-System, die zum Klassifizieren von Artefakten verwendet wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Der eindeutige Bezeichner für die vom System zugewiesene Artefaktkategorie. |
|
categoryName
|
categoryName | string |
Der Anzeigename der Kategorie, die zum Klassifizieren von Artefakten verwendet wird. |
Kategorie
Eine Kategorie im Panviva-System, die zum Klassifizieren von Artefakten verwendet wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Der eindeutige Bezeichner für die Kategorie. |
|
dateCreated
|
dateCreated | date-time |
Das Datum und die Uhrzeit der Erstellung der Kategorie. |
|
dateModified
|
dateModified | date-time |
Datum und Uhrzeit der letzten Änderung der Kategorie. |
|
name
|
name | string |
Der Anzeigename der Kategorie. |
Kanal
Eine Liste der Kanäle, über die diese Variation übermittelt werden kann.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Der eindeutige Bezeichner für den Kanal. |
|
name
|
name | string |
Der Name des Kanals für die Inhaltsübermittlung. |
Container
Ein Container im Panviva-System, der Inhalte, Metadaten und Links zu anderen Ressourcen enthalten kann.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner für den Container, in der Regel im Format "document-version-section-subsection". |
|
name
|
name | string |
Der Anzeigename oder titel des Containers. |
|
body
|
body | string |
Der HTML-Inhalt des Containers, der den tatsächlich anzuzeigenden Inhalt darstellt. |
ContainerRelationship
Eine Beziehung zwischen Containern, die die Hierarchie und Struktur von Inhalten in Panviva angibt.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner des Containers in dieser Beziehung. |
|
parent
|
parent | string |
Der Bezeichner des übergeordneten Containers oder null, wenn es sich um einen Container auf oberster Ebene handelt. |
|
Untergeordnetes Element
|
children | array of string | |
|
taskFlow
|
taskFlow | string |
Der Vorgangsflussbezeichner, der dieser Containerbeziehung zugeordnet ist, falls zutreffend. |
Dokument
Ein Dokument im Panviva-System, das Inhalte, Metadaten und Links zu anderen Ressourcen enthalten kann.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner für das Dokument. |
|
name
|
name | string |
Der Titel oder Name des Dokuments. |
|
Beschreibung
|
description | string |
Eine kurze Zusammenfassung, die den Inhalt des Dokuments beschreibt. |
|
Ausgabe
|
version | integer |
Die Versionsnummer des Dokuments. |
|
language
|
language | string |
Der Sprachcode für das Dokument (z. B. en-AU für Australisches Englisch). |
|
tags
|
tags | array of Tag | |
|
ausgeblendet
|
hidden | boolean |
Gibt an, ob das Dokument in Standardansichten ausgeblendet ist. |
|
source
|
source | string |
Die Quelle oder der Ursprung des Dokuments. |
|
type
|
type | string |
Der Ressourcentyp (immer "Dokument" für Document-Objekte). |
|
Freigabe
|
release | integer |
Die Versionsnummer des Dokuments. |
|
herausgegeben
|
released | boolean |
Gibt an, ob das Dokument veröffentlicht/veröffentlicht wurde. |
|
Urheberrecht
|
copyright | string |
Copyright-Informationen für das Dokument. |
|
classification
|
classification | string |
Die Klassifizierungskategorie des Dokuments (z. B. "Filme"). |
|
status
|
status | string |
Der aktuelle Status des Dokuments (z. B. "Phase 3"). |
|
Prozentwert
|
percentage | integer |
Der Fertigstellungsprozentsatz des Dokuments, in der Regel 100 für vollständig abgeschlossene Dokumente. |
|
releaseDate
|
releaseDate | date-time |
Das Datum und die Uhrzeit der Veröffentlichung des Dokuments. |
|
Layout
|
layout | string |
Die für das Dokument verwendete Seitenlayoutvorlage (z. B. "leftTabsMedium"). |
|
Ausbildung
|
training | Training |
Schulungsbezogene Einstellungen und Informationen für dieses Dokument. |
|
Schlüsselwörter
|
keywords | array of string |
Schlüsselwörter, die dem Dokument für die Standardsuche zugeordnet sind. |
|
cshKeywords
|
cshKeywords | array of string |
Dem Dokument zugeordnete Schlüsselwörter für kontextbezogene Hilfe (CSH). |
|
updatedDate
|
updatedDate | date-time |
Datum und Uhrzeit der letzten Aktualisierung des Dokuments. |
|
Erstellungsdatum
|
createdDate | date-time |
Das Datum und die Uhrzeit der Erstellung des Dokuments. |
|
wiederverwendbarer Inhalt
|
reusableContent | boolean |
Gibt an, ob das Dokument wiederverwendbare Inhaltsblöcke enthält. |
|
changeNote
|
changeNote | string |
Hinweise zur Beschreibung der Änderungen, die in der neuesten Version vorgenommen wurden. |
|
Verknüpfungen
|
links | array of Link |
EnrichedResponseVariation
Eine Variante des Artefakts, die über verschiedene Kanäle geliefert werden kann.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Der eindeutige Bezeichner für die Variation. |
|
dateCreated
|
dateCreated | date-time |
Das Datum und die Uhrzeit der Erstellung der Variation. |
|
dateModified
|
dateModified | date-time |
Datum und Uhrzeit der letzten Änderung der Variation. |
|
Inhalt
|
content | array of ResponseSection | |
|
simpleContent
|
simpleContent | string |
Eine vereinfachte Version des Inhalts, in der Regel nur Text. |
|
Kanäle
|
channels | array of Channel |
EnrichedSearchResult
Ein angereichertes Suchergebnis, das von der Panviva-API zurückgegeben wurde und detaillierte Informationen über das Artefakt enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid |
Der eindeutige Bezeichner für das erweiterte Suchergebnis. |
|
Inhalt
|
content | array of ResponseSection | |
|
simpleContent
|
simpleContent | string |
Eine vereinfachte Version des Inhalts, in der Regel nur Text. |
|
Kategorie
|
category | Category |
Eine Kategorie im Panviva-System, die zum Klassifizieren von Artefakten verwendet wird. |
|
Metadaten
|
metaData | object | |
|
searchScore
|
searchScore | number |
Die Relevanzbewertung des Suchergebnisses, die angibt, wie gut sie mit der Suchabfrage übereinstimmt. |
|
Verknüpfungen
|
links | array of Link | |
|
queryVariations
|
queryVariations | array of QueryVariation | |
|
primaryQuery
|
primaryQuery | string |
Die primäre Suchabfrage, die zum Abrufen dieses Ergebnisses verwendet wurde. |
|
panvivaDocumentId
|
panvivaDocumentId | integer |
Der eindeutige Bezeichner des Panviva-Dokuments, das diesem Ergebnis zugeordnet ist. |
|
panvivaDocumentVersion
|
panvivaDocumentVersion | integer |
Die Versionsnummer des Panviva-Dokuments, das diesem Ergebnis zugeordnet ist. |
|
title
|
title | string |
Der Titel des erweiterten Suchergebnisses. |
|
Höhepunkte
|
highlights | Highlights |
Hervorhebungen des Suchergebnisses, die normalerweise verwendet werden, um übereinstimmende Ausdrücke oder Ausdrücke anzugeben. |
Facette
Ein Facet zum Filtern von Suchergebnissen basierend auf bestimmten Kriterien.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
field
|
field | string |
Der Name des Felds, das für das Faceting verwendet wird. |
|
Gruppen
|
groups | array of StringInt64NullableKeyValuePair |
Ordner
Ein Ordner im Panviva-System, der zum Organisieren von Dokumenten und Artefakten verwendet wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner für den Ordner. |
|
name
|
name | string |
Der Anzeigename des Ordners. |
|
Beschreibung
|
description | string |
Eine kurze Zusammenfassung, die den Inhalt des Ordners beschreibt. |
|
Ausgabe
|
version | integer |
Die Versionsnummer des Ordners. |
|
language
|
language | string |
Der Sprachcode für den Ordner (z. B. en-AU für Australisches Englisch). |
|
tags
|
tags | array of Tag | |
|
ausgeblendet
|
hidden | boolean |
Gibt an, ob der Ordner in Suchansichten ausgeblendet ist. |
|
source
|
source | string |
Die Quelle oder der Ursprung des Ordners. |
|
type
|
type | string |
Der Ressourcentyp (immer 'Ordner' für Ordnerobjekte). |
|
Verknüpfungen
|
links | array of Link |
GetArtefactCategoriesResponse
Die Antwort der Panviva-API, die Artefaktkategoriendaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
categories
|
categories | array of ArtefactCategory |
GetContainerResponse
Die Antwort der Panviva-API, die Containerdaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner des Containers. |
|
name
|
name | string |
Der Anzeigename des Containers. |
|
body
|
body | string |
Der HTML-Inhalt des Containers. |
GetDocumentContainerRelationshipsResponse
Die Antwort der Panviva-API, die Dokumentcontainerbeziehungen enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Beziehungen
|
relationships | array of ContainerRelationship |
GetDocumentContainersResponse
Die Antwort der Panviva-API, die Dokumentcontainerdaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Container
|
containers | array of Container |
GetDocumentResponse
Die Antwort der Panviva-API, die Dokumentdaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner für das Dokument. |
|
name
|
name | string |
Der Titel oder Name des Dokuments. |
|
Beschreibung
|
description | string |
Eine kurze Zusammenfassung, die den Inhalt des Dokuments beschreibt. |
|
Ausgabe
|
version | integer |
Die Versionsnummer des Dokuments. |
|
language
|
language | string |
Der Sprachcode für das Dokument (z. B. en-AU für Australisches Englisch). |
|
tags
|
tags | array of Tag | |
|
ausgeblendet
|
hidden | boolean |
Gibt an, ob das Dokument bei der Suche ausgeblendet ist. |
|
source
|
source | string |
Die Quelle oder der Ursprung des Dokuments. |
|
type
|
type | string |
Der Ressourcentyp (immer "Dokument" für Document-Objekte). |
|
Freigabe
|
release | integer |
Die Versionsnummer des Dokuments. |
|
herausgegeben
|
released | boolean |
Gibt an, ob das Dokument veröffentlicht/veröffentlicht wurde. |
|
Urheberrecht
|
copyright | string |
Copyright-Informationen für das Dokument. |
|
classification
|
classification | string |
Die Klassifizierungskategorie des Dokuments (z. B. "Filme"). |
|
status
|
status | string |
Der aktuelle Status des Dokuments (z. B. "Phase 3"). |
|
Prozentwert
|
percentage | integer | |
|
releaseDate
|
releaseDate | date-time |
Das Datum und die Uhrzeit der Veröffentlichung des Dokuments. |
|
Layout
|
layout | string |
Die für das Dokument verwendete Seitenlayoutvorlage (z. B. "leftTabsMedium"). |
|
Ausbildung
|
training | Training |
Schulungsbezogene Einstellungen und Informationen für dieses Dokument. |
|
Schlüsselwörter
|
keywords | array of string | |
|
cshKeywords
|
cshKeywords | array of string | |
|
updatedDate
|
updatedDate | date-time |
Datum und Uhrzeit der letzten Aktualisierung des Dokuments. |
|
Erstellungsdatum
|
createdDate | date-time |
Das Datum und die Uhrzeit der Erstellung des Dokuments. |
|
wiederverwendbarer Inhalt
|
reusableContent | boolean |
Gibt an, ob das Dokument wiederverwendbare Inhaltsblöcke enthält. |
|
changeNote
|
changeNote | string |
Hinweise zur Beschreibung der Änderungen, die in der neuesten Version vorgenommen wurden. |
|
Verknüpfungen
|
links | array of Link |
GetDocumentTranslationsResponse
Die Antwort der Panviva-API, die Dokumentübersetzungsdaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Übersetzungen
|
translations | array of Document | |
|
origin
|
origin | string |
Der Ursprung der Übersetzung, in der Regel die ID des Originaldokuments. |
GetEnrichedResponseResponse
Die Antwort der Panviva-API mit erweiterten Antwortdaten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Verknüpfungen
|
links | array of Link | |
|
title
|
title | string |
Der Titel der erweiterten Antwort. |
|
Inhalt
|
content | array of ResponseSection | |
|
simpleContent
|
simpleContent | string |
Eine vereinfachte Version des Inhalts, in der Regel nur Text. |
|
Variationen
|
variations | array of EnrichedResponseVariation | |
|
Kategorie
|
category | Category |
Eine Kategorie im Panviva-System, die zum Klassifizieren von Artefakten verwendet wird. |
|
primaryQuery
|
primaryQuery | string |
Die primäre Suchabfrage, die zum Abrufen dieser Antwort verwendet wurde. |
|
queryVariations
|
queryVariations | array of QueryVariation | |
|
panvivaDocumentId
|
panvivaDocumentId | integer |
Der eindeutige Bezeichner des Panviva-Dokuments, das dieser Antwort zugeordnet ist. |
|
panvivaDocumentVersion
|
panvivaDocumentVersion | integer |
Die Versionsnummer des Panviva-Dokuments, das dieser Antwort zugeordnet ist. |
|
Metadaten
|
metaData | object | |
|
id
|
id | uuid |
Der eindeutige Bezeichner für die erweiterte Antwort. |
|
dateCreated
|
dateCreated | date-time |
Datum und Uhrzeit der Erstellung der erweiterten Antwort. |
|
dateModified
|
dateModified | date-time |
Datum und Uhrzeit der letzten Änderung der erweiterten Antwort. |
GetEnrichedSearchArtefactResponse
Die Antwort der Panviva-API mit erweiterten Suchartefaktedaten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
facetten
|
facets | array of Facet | |
|
results
|
results | array of EnrichedSearchResult | |
|
gesamt
|
total | integer |
Die Gesamtzahl der gefundenen Suchergebnisse. |
GetFileResponse
Die Antwort der Panviva-API, die Dateidaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
name
|
name | string | |
|
Beschreibung
|
description | string | |
|
Ausgabe
|
version | integer | |
|
language
|
language | string | |
|
tags
|
tags | array of Tag | |
|
ausgeblendet
|
hidden | boolean | |
|
source
|
source | string | |
|
type
|
type | string | |
|
Inhalt
|
content | string | |
|
fileName
|
fileName | string | |
|
Freigabe
|
release | integer | |
|
herausgegeben
|
released | boolean | |
|
Urheberrecht
|
copyright | string | |
|
classification
|
classification | string | |
|
status
|
status | string | |
|
Prozentwert
|
percentage | integer | |
|
releaseDate
|
releaseDate | date-time | |
|
Schlüsselwörter
|
keywords | array of string | |
|
cshKeywords
|
cshKeywords | array of string | |
|
changeNote
|
changeNote | string | |
|
updatedDate
|
updatedDate | date-time | |
|
Erstellungsdatum
|
createdDate | date-time |
GetFolderChildrenResponse
Die Antwort der Panviva-API, die Ordner-untergeordnete Daten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Untergeordnetes Element
|
children | array of Resource |
GetFolderResponse
Die Antwort der Panviva-API, die Ordnerdaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner für den Ordner. |
|
name
|
name | string |
Der Anzeigename des Ordners. |
|
Beschreibung
|
description | string |
Eine kurze Zusammenfassung, die den Inhalt des Ordners beschreibt. |
|
Ausgabe
|
version | integer |
Die Versionsnummer des Ordners. |
|
language
|
language | string |
Der Sprachcode für den Ordner (z. B. en-AU für Australisches Englisch). |
|
tags
|
tags | array of Tag | |
|
ausgeblendet
|
hidden | boolean |
Gibt an, ob der Ordner in Suchansichten ausgeblendet ist. |
|
source
|
source | string |
Die Quelle oder der Ursprung des Ordners. |
|
type
|
type | string |
Der Ressourcentyp (immer 'Ordner' für Ordnerobjekte). |
|
Verknüpfungen
|
links | array of Link |
GetFolderRootResponse
Die Antwort der Panviva-API, die Stammordnerdaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner für den Stammordner. |
|
name
|
name | string |
Der Anzeigename des Stammordners. |
|
Beschreibung
|
description | string |
Eine kurze Zusammenfassung, die den Inhalt des Stammordners beschreibt. |
|
Ausgabe
|
version | integer |
Die Versionsnummer des Stammordners. |
|
language
|
language | string |
Der Sprachcode für den Stammordner (z. B. en-AU für Australisches Englisch). |
|
tags
|
tags | array of Tag | |
|
ausgeblendet
|
hidden | boolean |
Gibt an, ob der Stammordner in Suchansichten ausgeblendet ist. |
|
source
|
source | string |
Die Quelle oder der Ursprung des Stammordners. |
|
type
|
type | string |
Der Ressourcentyp (immer 'Ordner' für Ordnerobjekte). |
|
Verknüpfungen
|
links | array of Link |
GetFolderTranslationsResponse
Die Antwort der Panviva-API, die Ordnerübersetzungsdaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Übersetzungen
|
translations | array of Folder |
GetImageResponse
Die Antwort der Panviva-API, die Bilddaten enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner für das Bild. |
|
name
|
name | string |
Der Titel oder Name des Bilds. |
|
width
|
width | integer |
Die Breite des Bilds in Pixeln. |
|
height
|
height | integer |
Die Höhe des Bilds in Pixeln. |
|
size
|
size | integer |
Die Größe der Bilddatei in Byte. |
|
Inhaltstyp
|
contentType | string |
Der MIME-Typ des Bilds (z. B. Image/jpeg, image/png). |
|
Inhalt
|
content | string |
Der base64-codierte Inhalt des Bilds. |
Höhepunkte
Hervorhebungen des Suchergebnisses, die normalerweise verwendet werden, um übereinstimmende Ausdrücke oder Ausdrücke anzugeben.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
primaryQuery
|
primaryQuery | string |
Die primäre Suchabfrage, die zum Abrufen dieses Ergebnisses verwendet wurde. |
|
title
|
title | string |
Der Titel des erweiterten Suchergebnisses. |
Link
Hypermedia-Links im Zusammenhang mit dieser Ressource.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
href
|
href | string |
Die URL für den Zugriff auf die zugehörige Ressource oder Ausführen eines Vorgangs. |
|
rel
|
rel | string |
Der Beziehungstyp der Verknüpfung mit der aktuellen Ressource (z. B. "Dokument", "Datei"). |
|
type
|
type | string |
Die HTTP-Methode, die beim Zugriff auf diesen Link verwendet werden soll (in der Regel 'GET'). |
PostArtefactCategoryResponse
Die Antwort der Panviva-API nach der Erstellung einer neuen Artefaktkategorie.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
categoryId
|
categoryId | integer |
Der eindeutige Bezeichner der neu erstellten Artefaktkategorie. |
|
categoryName
|
categoryName | string |
Der Anzeigename der neu erstellten Artefaktkategorie. |
PostArtefactResponse
Die Antwort der Panviva-API nach der Erstellung eines neuen Artefakts.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
hasErrors
|
hasErrors | boolean |
Gibt an, ob während der Artefakterstellung Fehler aufgetreten sind. |
|
Irrtümer
|
errors | array of string | |
|
responseId
|
responseId | uuid |
Der eindeutige Bezeichner des neu geschaffenen Artefakts. |
PutArtefactResponse
Die Antwort der Panviva-API nach der Aktualisierung eines Artefakts.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
hasErrors
|
hasErrors | boolean |
Gibt an, ob während der Artefaktaktualisierung Fehler aufgetreten sind. |
|
Irrtümer
|
errors | array of string | |
|
status
|
status | string |
Der Status des Artefaktaktualisierungsvorgangs. |
QueryVariation
Alternative Ausdrücke von Abfragen, die diesem Artefakt entsprechen sollten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Anfrage
|
query | string |
Der Suchabfragetext. |
Resource
Eine Ressource, die ein Dokument, ein Ordner oder andere Inhaltstypen sein kann.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Der eindeutige Bezeichner der Ressource. |
|
name
|
name | string |
Der Anzeigename der Ressource. |
|
Beschreibung
|
description | string |
Eine kurze Zusammenfassung, die den Inhalt der Ressource beschreibt. |
|
Ausgabe
|
version | integer |
Die Versionsnummer der Ressource. |
|
language
|
language | string |
Der Sprachcode für die Ressource (z. B. en-AU für Australisches Englisch). |
|
tags
|
tags | array of Tag | |
|
ausgeblendet
|
hidden | boolean |
Gibt an, ob die Ressource in Standardansichten ausgeblendet ist. |
|
source
|
source | string |
Die Quelle oder der Ursprung der Ressource. |
|
type
|
type | string |
Der Ressourcentyp (z. B. "Dokument", "Ordner"). |
ResponseSection
Die Inhaltsabschnitte der Antwort.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
mediaType
|
mediaType | string |
Der Medientyp des Inhalts (z. B. "text/html", "text/plain"). |
|
Text
|
text | string |
Der Textinhalt des Abschnitts. |
|
href
|
href | string |
Ein Link zu zusätzlichen Inhalten oder Ressourcen. |
|
resourceLocation
|
resourceLocation | string |
Der Speicherort der Ressource, in der Regel eine URL oder ein Dateipfad. |
StringInt64NullableKeyValuePair
Ein Schlüssel-Wert-Paar, bei dem der Schlüssel eine Zeichenfolge und der Wert eine ganze Zahl ist.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
key
|
key | string |
Der Name der Facetgruppe. |
|
value
|
value | integer |
Die Anzahl der Elemente in dieser Facetgruppe. |
Tag
Ein Metadatentag, das der Ressource zugeordnet ist.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
Der Name oder der Schlüssel des Tags. |
|
value
|
value | string |
Der dem Tag zugeordnete Wert. |
Ausbildung
Schulungsbezogene Einstellungen und Informationen für dieses Dokument.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
failureFeedback
|
failureFeedback | string |
Die Feedbackmeldung, die angezeigt wird, wenn ein Benutzer eine Schulung für dieses Dokument fehlschlägt. |
|
forcePageSequence
|
forcePageSequence | boolean |
Bei "true" müssen Benutzer seiten während der Schulung in Sequenz anzeigen. |
|
forceQuestionSequence
|
forceQuestionSequence | boolean |
Wenn dies der Fall ist, müssen Die Benutzer während der Schulung Fragen in Sequenz beantworten. |
|
passingScore
|
passingScore | integer |
Die Mindestbewertung, die bestanden werden muss. |
|
successFeedback
|
successFeedback | string |
Die Feedbackmeldung, die angezeigt wird, wenn ein Benutzer schulungen für dieses Dokument bestanden hat. |
Objekt
Dies ist der Typ 'object'.