Panviva
Panviva ist eine Omnichannel Knowledge Management-Lösung. Unsere Priorität ist es, unseren Kunden dabei zu helfen, ihre Mitarbeiter glücklich zu halten, damit sie sich darauf konzentrieren können, dass ihre Kunden zufrieden sind. Die digitale Transformation von Organisationen in den letzten 20 Jahren hilft unseren Kunden jetzt dabei, Ihren Mitarbeitern und Kunden Wissen zu vermitteln, ganz gleich, ob sie im Haus oder im Büro sind – jederzeit und überall.
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 | Panviva Customer Advocacy Team |
| URL | https://www.panviva.com/support |
| support@panviva.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Panviva |
| Webseite | https://www.panviva.com |
| Datenschutzrichtlinie | https://www.panviva.com/privacy-policy |
| Kategorien | Unternehmensführung; Produktivität |
Voraussetzungen
Um den Panviva-Verbinder zu verwenden, müssen Sie folgendes haben:
- Zugriff auf eine Panviva-Instanz (auch bekannt als Mandant)
- Ein Entwicklerkonto im Panviva-Entwicklerportal (dev.panviva.com)
- Ein aktives Panviva-API-Abonnement (auch bekannt als API-Plan) und gültige Panviva-API-Anmeldeinformationen
Wenn Sie kein Kunde sind oder Hilfe
So erhalten Sie Anmeldeinformationen
Führen Sie die folgenden Schritte aus, um Ihren API-Schlüssel und die API-Instanz abzurufen.
Wenn beim Verwenden des Connectors ein Fehler angezeigt wird, können Sie den Fehlercode nachschlagen, um weitere Informationen zu finden. Hinweis: Der HTTP-Statuscode in der Dokumentation unterscheidet sich möglicherweise geringfügig von dem, was Sie in Power Automate oder Power Apps sehen, verwenden Sie bitte das Feld "Fehlercode" für Nachschlagezwecke.
Um Ihren API-Schlüssel zu erhalten, müssen Sie:
- Melden Sie sich beim Panviva-Entwicklerportal bei dev.panviva.com
- Navigieren Sie zu Ihrem Profil (klicken Sie auf Ihren Namen und dann auf "Profil" in der oberen Navigationsleiste).
- Ihr API-Schlüssel sollte nun im Abschnitt "Ihre Abonnements" Ihres Profils angezeigt werden.
Um Ihre API-Instanz abzurufen, müssen Sie:
- Melden Sie sich beim Panviva-Entwicklerportal bei dev.panviva.com
- Navigieren Sie zu Ihrer API (klicken Sie auf "APIs" in der oberen Navigationsleiste)
- Nun sollte Ihre API-Instanz unter Ihrer API-Suite angezeigt werden (suchen Sie nach "Der Instanzname für die API-Suite ist")
Drosselungslimits
Beachten Sie, dass Ihre Einschränkungsgrenzwerte auf dem Typ des API-Abonnements (oder API-Plans) basieren, für den Sie abonniert haben.
So finden Sie Ihr Kontingent oder Ihr Zinslimit:
- Melden Sie sich beim Panviva-Entwicklerportal bei dev.panviva.com
- Navigieren Sie zu Ihrem Profil (klicken Sie auf Ihren Namen und dann auf "Profil" in der oberen Navigationsleiste).
- Wechseln Sie zu Ihrem API-Plan im Abschnitt "Ihre Abonnements" Ihres Profils
- Nun sollten die Details Ihres Plans angezeigt werden (suchen Sie nach "... kann ** Anrufe/Minute bis zu einem Maximum von _** Anrufen/Monat ausführen...")
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 |
|---|---|---|---|
| Panviva-API-Abonnementschlüssel | securestring | Der Panviva-API-Abonnementschlüssel für Ihre Instanz. | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Artefakt |
Zurückgeben eines Artefakts mithilfe der bereitgestellten ID |
| Artefakte suchen |
Zurückgeben von Suchergebnissen für eine bestimmte Abfrage |
| Artefaktkategorie erstellen |
Erstellt eine Kategorie zum Klassifizieren von Artefakten |
| Artefaktkategorien abrufen |
Ruft eine Liste aller verfügbaren Artefaktkategorien ab. |
| Bild |
Gibt ein Bild aus Panviva zurück. Bilddaten werden als base64-Zeichenfolge dargestellt. |
| Container |
Zurückgeben eines Containers mithilfe der bereitgestellten Container-ID |
| Datei |
Gibt eine Datei (externes Dokument) aus Panviva zurück. |
| Dokument |
Zurückgeben eines Dokuments mithilfe der bereitgestellten Dokument-ID |
| Dokumentcontainer |
Zurückgeben einer Liste von Containern mithilfe der bereitgestellten Dokument-ID |
| Dokumentcontainerbeziehungen |
Zurückgeben einer Liste der Beziehungen zwischen den übergeordneten und untergeordneten Elementen zwischen jedem Container für die bereitgestellte Dokument-ID |
| Dokumentübersetzungen |
Zurückgeben einer Liste aller Übersetzungen (pro Sprache und Gebietsschema) eines Panviva-Dokuments |
| Live CSH |
Stellen Sie eine CSH-Suchergebnisseite der übergebenden Abfrage auf dem Panviva-Client für den angegebenen Benutzer auf dem Panviva-Client bereit. |
| Live-Suche |
Präsentieren einer Suchergebnisseite der übergebenen Abfrage auf dem Panviva-Client an den angegebenen Benutzer auf dem Panviva-Client |
| Livedokument |
Präsentieren einer Dokumentseite für den angegebenen Benutzer auf dem Panviva-Client |
| Ordner |
Zurückgeben von Informationen zu einem Panviva-Ordner und Verweisen auf jedes seiner direkten untergeordneten Elemente |
| Ordnerstamm |
Ruft den Stamm-/Startordner in all 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. |
| Ordnerübersetzungen |
Ruft alle Übersetzungen eines Panviva-Ordners zusammen mit den jeweiligen übersetzten Ordnern ab. |
| Suche |
Durchsucht Dokumente, Ordner und Dateien (externe Dokumente) nach einem Ausdruck und gibt paginierte Ergebnisse zurück. |
| Untergeordnete Ordner |
Ruft alle unmittelbaren untergeordneten Elemente eines Panviva-Ordners ab, nicht einschließlich Enkelkindern. Untergeordnete Elemente können Ordner, Dokumente oder Dateien (externe Dokumente) sein. |
Artefakt
Zurückgeben eines Artefakts mithilfe der bereitgestellten ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | string |
Format - uuid. Id (ID) eines Artefakts |
Gibt zurück
- Body
- GetResponseResponse
Artefakte suchen
Zurückgeben von Suchergebnissen für eine bestimmte Abfrage
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Einfache Abfrage
|
simplequery | string |
Abfragezeichenfolge für natürliche Sprache. Beispiel: "Action Movies". (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 Lucene-formatierte Filterzeichenfolge. Beispiele: 'category eq "Hypotheken", 'panvivaDocumentVersion gt "8". (Filterbare Felder umfassen dateCreated, dateModified, dateDeleted, categoryJson, queryVariationsJson, title, category, primaryQuery, isDeleted, timestamp, panvivaDocumentId, panvivaDocumentVersion, id) |
|
|
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. Beispielsweise würde pageOffset von 100 und pageLimit von 10 Datensätze 101-110 zurückgeben. |
|
|
Seitenlimit
|
pageLimit | integer |
Die Anzahl der zurückzugebenden Datensätze. Muss eine ganze Zahl zwischen 0 und 1000 sein. |
|
|
Facette
|
facet | string |
Akzeptiert eine Lucene-formatierte Facetzeichenfolge. Beispiele: 'facet=Category,count:10&facet=Rating'. (Facetable-Felder enthalten MetaData/Werte) |
Gibt zurück
Artefaktkategorie erstellen
Erstellt eine Kategorie zum Klassifizieren von Artefakten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
name
|
name | string |
Gibt zurück
Artefaktkategorien abrufen
Ruft eine Liste aller verfügbaren Artefaktkategorien ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
Gibt zurück
Bild
Gibt ein Bild aus Panviva zurück. Bilddaten werden als base64-Zeichenfolge dargestellt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | integer |
Die ID eines Panviva-Bilds |
Gibt zurück
- Body
- GetImageResponse
Container
Zurückgeben eines Containers mithilfe der bereitgestellten Container-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | string |
Die ID eines Dokumentcontainers |
Gibt zurück
- Body
- GetContainerResponse
Datei
Gibt eine Datei (externes Dokument) aus Panviva zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | integer |
Die interne ID (IID) einer Panviva-Datei (externes Dokument) |
Gibt zurück
- Body
- GetFileResponse
Dokument
Zurückgeben eines Dokuments mithilfe der bereitgestellten Dokument-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
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. |
|
Version
|
version | integer |
Fordern Sie die API an, eine bestimmte Version des angegebenen Dokuments zurückzugeben. |
Gibt zurück
- Body
- GetDocumentResponse
Dokumentcontainer
Zurückgeben einer Liste von Containern mithilfe der bereitgestellten Dokument-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | integer |
Die interne ID (IID) eines Panviva-Dokuments |
Gibt zurück
Dokumentcontainerbeziehungen
Zurückgeben einer Liste der Beziehungen zwischen den übergeordneten und untergeordneten Elementen zwischen jedem Container für die bereitgestellte Dokument-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | integer |
Die interne ID (IID) eines Panviva-Dokuments |
Gibt zurück
Dokumentübersetzungen
Zurückgeben einer Liste aller Übersetzungen (pro Sprache und Gebietsschema) eines Panviva-Dokuments
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | integer |
Die interne ID (IID) eines Panviva-Dokuments. |
Gibt zurück
Live CSH
Stellen Sie eine CSH-Suchergebnisseite der übergebenden Abfrage auf dem Panviva-Client für den angegebenen Benutzer auf dem Panviva-Client bereit.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
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
- response
- object
Live-Suche
Präsentieren einer Suchergebnisseite der übergebenen Abfrage auf dem Panviva-Client an den angegebenen Benutzer auf dem Panviva-Client
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
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
- response
- object
Livedokument
Präsentieren einer Dokumentseite für den angegebenen Benutzer auf dem Panviva-Client
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
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, wenn das angegebene Dokument geöffnet wird. |
|
|
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
- response
- object
Ordner
Zurückgeben von Informationen zu einem Panviva-Ordner und Verweisen auf jedes seiner direkten untergeordneten Elemente
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | integer |
Die interne ID (IID) eines Panviva-Ordners |
Gibt zurück
- Body
- GetFolderResponse
Ordnerstamm
Ruft den Stamm-/Startordner in all 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.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
Gibt zurück
Ordnerübersetzungen
Ruft alle Übersetzungen eines Panviva-Ordners zusammen mit den jeweiligen übersetzten Ordnern ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | integer |
Die interne ID (IID) eines Panviva-Ordners |
Gibt zurück
Suche
Durchsucht Dokumente, Ordner und Dateien (externe Dokumente) nach einem Ausdruck und gibt paginierte Ergebnisse zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Begriff
|
term | True | string |
Das Wort oder der Ausdruck, nach dem gesucht werden soll |
|
Seitenoffset
|
pageOffset | integer |
Der Paginierungsoffset, um die Anzahl der zu überspringenden anfänglichen Suchergebnisse anzuzeigen. Beispielsweise würde pageOffset von 100 und pageLimit von 10 Datensätze 101-110 zurückgeben. |
|
|
Seitenlimit
|
pageLimit | integer |
Die Anzahl der zurückzugebenden Datensätze. Muss eine ganze Zahl zwischen 0 und 1000 sein. |
Gibt zurück
- Body
- GetSearchResponse
Untergeordnete Ordner
Ruft alle unmittelbaren untergeordneten Elemente eines Panviva-Ordners ab, nicht einschließlich Enkelkindern. Untergeordnete Elemente können Ordner, Dokumente oder Dateien (externe Dokumente) sein.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Instance
|
instance | True | string |
Der Instanzname, wie im Panviva Developer Portal dargestellt. |
|
Id
|
id | True | integer |
Die interne ID (IID) eines Panviva-Ordners |
Gibt zurück
Definitionen
Link
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
href
|
href | string | |
|
rel
|
rel | string | |
|
type
|
type | string |
ResourceSearchResult
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
type
|
type | string | |
|
id
|
id | string | |
|
name
|
name | string | |
|
Beschreibung
|
description | string | |
|
matchedFields
|
matchedFields | array of string | |
|
Schnipsel
|
snippet | string | |
|
language
|
language | string | |
|
Verknüpfungen
|
links | array of Link |
GetSearchResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
results
|
results | array of ResourceSearchResult | |
|
gesamt
|
total | integer | |
|
Verknüpfungen
|
links | array of Link |
StringInt64NullableKeyValuePair
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
key
|
key | string | |
|
value
|
value | integer |
Facette
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
field
|
field | string | |
|
Gruppen
|
groups | array of StringInt64NullableKeyValuePair |
ResponseSection
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
mediaType
|
mediaType | string | |
|
Text
|
text | string | |
|
href
|
href | string | |
|
resourceLocation
|
resourceLocation | string |
Kategorie
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string | |
|
id
|
id | integer | |
|
dateCreated
|
dateCreated | date-time | |
|
dateModified
|
dateModified | date-time |
QueryVariation
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
Anfrage
|
query | string |
SearchResult
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
Inhalt
|
content | array of ResponseSection | |
|
Kategorie
|
category | Category | |
|
Metadaten
|
metaData | object | |
|
searchScore
|
searchScore | number | |
|
Verknüpfungen
|
links | array of Link | |
|
queryVariations
|
queryVariations | array of QueryVariation | |
|
primaryQuery
|
primaryQuery | string | |
|
panvivaDocumentId
|
panvivaDocumentId | integer | |
|
panvivaDocumentVersion
|
panvivaDocumentVersion | integer | |
|
title
|
title | string |
GetSearchArtefactResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
facetten
|
facets | array of Facet | |
|
results
|
results | array of SearchResult | |
|
gesamt
|
total | integer |
GetContainerResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
name
|
name | string | |
|
body
|
body | string |
Tag
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string | |
|
value
|
value | string |
Ausbildung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
failureFeedback
|
failureFeedback | string | |
|
forcePageSequence
|
forcePageSequence | boolean | |
|
forceQuestionSequence
|
forceQuestionSequence | boolean | |
|
passingScore
|
passingScore | integer | |
|
successFeedback
|
successFeedback | string |
GetDocumentResponse
| 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 | |
|
Freigabe
|
release | integer | |
|
herausgegeben
|
released | boolean | |
|
Urheberrecht
|
copyright | string | |
|
classification
|
classification | string | |
|
status
|
status | string | |
|
Prozentwert
|
percentage | integer | |
|
releaseDate
|
releaseDate | date-time | |
|
Layout
|
layout | string | |
|
Ausbildung
|
training | Training | |
|
Schlüsselwörter
|
keywords | array of string | |
|
cshKeywords
|
cshKeywords | array of string | |
|
updatedDate
|
updatedDate | date-time | |
|
Erstellungsdatum
|
createdDate | date-time | |
|
wiederverwendbarer Inhalt
|
reusableContent | boolean | |
|
changeNote
|
changeNote | string | |
|
Verknüpfungen
|
links | array of Link |
Kanal
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
ResponseVariation
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Inhalt
|
content | array of ResponseSection | |
|
Kanäle
|
channels | array of Channel | |
|
id
|
id | integer | |
|
dateCreated
|
dateCreated | date-time | |
|
dateModified
|
dateModified | date-time |
GetResponseResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Verknüpfungen
|
links | array of Link | |
|
title
|
title | string | |
|
Inhalt
|
content | array of ResponseSection | |
|
Variationen
|
variations | array of ResponseVariation | |
|
Kategorie
|
category | Category | |
|
primaryQuery
|
primaryQuery | string | |
|
queryVariations
|
queryVariations | array of QueryVariation | |
|
panvivaDocumentId
|
panvivaDocumentId | integer | |
|
panvivaDocumentVersion
|
panvivaDocumentVersion | integer | |
|
Metadaten
|
metaData | object | |
|
id
|
id | uuid | |
|
dateCreated
|
dateCreated | date-time | |
|
dateModified
|
dateModified | date-time |
Container
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
name
|
name | string | |
|
body
|
body | string |
GetDocumentContainersResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Container
|
containers | array of Container |
ContainerRelationship
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
parent
|
parent | string | |
|
Untergeordnetes Element
|
children | array of string | |
|
taskFlow
|
taskFlow | string |
GetDocumentContainerRelationshipsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Beziehungen
|
relationships | array of ContainerRelationship |
Dokument
| 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 | |
|
Freigabe
|
release | integer | |
|
herausgegeben
|
released | boolean | |
|
Urheberrecht
|
copyright | string | |
|
classification
|
classification | string | |
|
status
|
status | string | |
|
Prozentwert
|
percentage | integer | |
|
releaseDate
|
releaseDate | date-time | |
|
Layout
|
layout | string | |
|
Ausbildung
|
training | Training | |
|
Schlüsselwörter
|
keywords | array of string | |
|
cshKeywords
|
cshKeywords | array of string | |
|
updatedDate
|
updatedDate | date-time | |
|
Erstellungsdatum
|
createdDate | date-time | |
|
wiederverwendbarer Inhalt
|
reusableContent | boolean | |
|
changeNote
|
changeNote | string | |
|
Verknüpfungen
|
links | array of Link |
GetDocumentTranslationsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Übersetzungen
|
translations | array of Document | |
|
origin
|
origin | string |
GetFileResponse
| 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 |
GetFolderResponse
| 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 | |
|
Verknüpfungen
|
links | array of Link |
Resource
| 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 |
GetFolderChildrenResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Untergeordnetes Element
|
children | array of Resource |
Ordner
| 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 | |
|
Verknüpfungen
|
links | array of Link |
GetFolderTranslationsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Übersetzungen
|
translations | array of Folder |
GetFolderRootResponse
| 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 | |
|
Verknüpfungen
|
links | array of Link |
GetImageResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
name
|
name | string | |
|
width
|
width | integer | |
|
height
|
height | integer | |
|
size
|
size | integer | |
|
Inhaltstyp
|
contentType | string | |
|
Inhalt
|
content | string |
ArtefaktKategory
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
categoryName
|
categoryName | string |
GetArtefactCategoriesResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
categories
|
categories | array of ArtefactCategory |
PostArtefactCategoryResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
categoryId
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Objekt
Dies ist der Typ „Objekt“.