Bei der Konfiguration des Content‑Federation‑Konnektoren wird durch die Aktion festgelegt, was der Konnektor ausführt.
Die folgenden Aktionen stehen für den Content-Federated-Konnektor zur Verfügung:
GET_CONTENT_PARTS
Minimale kompatible Version: CFS V3
Die GET_CONTENT_PARTS-Aktion liefert eine vorausgefüllte URL oder gestreamtes Binär für Teile eines bestimmten Inhalts. Dies kann nützlich sein, um die Teile anzuzeigen oder für Folgeprozesse zu verwenden.
Die Eingabeparameter der Aktion sind:
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| contentId | Zeichenfolge | Erforderlich | Die ID des Inhaltsbestandteils, für den die Eigenschaften abgerufen werden sollen |
| logicalPartIds | Array | Erforderlich | Die IDs der logischen Teile, die abgerufen werden sollen |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgte |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System mit einer Liste der verfügbaren Inhaltsbestandteile und ihrer Eigenschaften. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
SEARCH_CONTENTS
Minimale kompatible Version: CFS V2
Die SEARCH_CONTENTS-Aktion ermöglicht das Durchsuchen der Datenquelle, um Inhalte anhand spezifischer Kriterien wie Metadaten, Inhaltstyp oder Schlüsselwörtern zu finden.
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
Standardwert |
|---|---|---|---|---|
| offset | Zeichenfolge | Optional | Seiten‑Offset für die Paginierung. | 0 |
| pageSize | Zeichenfolge | Optional | Seitengröße des Inhalts. | 100 |
| searchContent | JSON | Erforderlich |
Parameter des zu durchsuchenden Inhalts. Sie können die Stiftschaltfläche neben diesem Feld verwenden, um das Dialogfeld Variablenzuordnung bearbeiten zu öffnen. Im Tab Wert können Sie die Suchparameter für die Aktion definieren, um die Suchergebnisse einzuschränken. |
k. A. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. | k. A. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
CREATE_CONTENT
Minimale kompatible Version: CFS V2
Die CREATE_CONTENT-Aktion erstellt neue Inhalte (wie Dokumente oder Datensätze) im Inhaltssystem. Sie lädt den Inhalt hoch und speichert ihn zusammen mit den zugehörigen Metadaten.
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| Content | JSON | Erforderlich | Inhalt, der erstellt wird. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
READ_FIELDS
Minimale kompatible Version: CFS V2
Die READ_FIELDS-Aktion ruft die Metadaten oder Felder ab, die mit einem Inhaltselement verbunden sind. Sie liefert beschreibende Daten wie Schlüsselwörter, Tags oder andere Attribute, die mit dem Inhalt zusammenhängen.
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| contentId | Zeichenfolge | Erforderlich | Bezeichner des Inhalts, dessen Metadaten gelesen werden. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
READ_CONTENTTYPE_GROUP
Minimale kompatible Version: CFS V2
Die READ_CONTENTTYPE_GROUP-Aktion liest Daten aus einer einzigen Inhaltstypgruppe, einschließlich aller ihrer Inhaltstypen.
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| contentTypeGroupId | Zeichenfolge | Erforderlich | Bezeichner des Gruppentyps, dessen Inhaltstyp gelesen wird. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
GET_RENDITION
Minimale kompatible Version: CFS V3
Die GET_RENDITION-Aktion ruft alle verfügbaren PDF-Darstellungen eines Inhaltsobjekts ab.
Die Eingabeparameter der Aktion sind:
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| contentId | Zeichenfolge | Erforderlich | Bezeichner des Inhalts, der gelesen wird |
| mimeType | Zeichenfolge | Erforderlich | MIME-Typ des Inhalts, der gelesen werden soll Der einzige akzeptierte Wert für diesen Parameter ist application/pdf. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgte |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| response | JSON | Optional | Eine Antwort vom System. Sie enthält den MIME-Typ und die Datei-Validierungsmetadaten. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
GET_OBJECT_QUERIES
Minimale kompatible Version: CFS V2
Die GET_OBJECT_QUERIES-Aktion liefert eine Liste der verfügbaren Suchanfragen innerhalb des Systems. Diese Abfragen werden verwendet, um durch strukturierte Daten (wie Patientendaten) zu suchen und helfen Benutzern, Schlüsselwortwerte für Inhalte zu erfassen.
Diese Aktion kann weiter mit den Aktionen GET_OBJECT_QUERY_DETAILS und dann EXECUTE_OBJECT_QUERY verbunden werden, um mit festgelegten Parametern eine Abfrage auszuführen.
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| offset | Zeichenfolge | Optional | Seiten‑Offset für die Paginierung. |
| pageSize | Zeichenfolge | Optional | Seitengröße des Inhalts. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
EXECUTE_OBJECT_QUERY
Minimale kompatible Version: CFS V2
Die EXECUTE_OBJECT_QUERY-Aktion ermöglicht es Benutzern, spezifische Suchkriterien einzugeben und eine Abfrage auszuführen. Sie liefert Ergebnisse, die mit den gegebenen Suchfeldern übereinstimmen, wie Datenobjekte oder Datensätze. Zum Beispiel würde diese Aktion, wenn der Benutzer nach Patientendaten sucht, übereinstimmende Datensätze auf Basis der bereitgestellten Suchparameter zurückgeben.
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| Content | JSON | Erforderlich |
Objektabfragefelder. Verwenden Sie den Bleistift-Button, um das Variablenzuordnung bearbeiten-Dialogfeld zu öffnen, in dem Sie die Abfragefelder für das Lookup im Wert-Tab hinzufügen können. |
| offset | Zeichenfolge | Optional | Seiten‑Offset für die Paginierung. |
| pageSize | Zeichenfolge | Optional | Seitengröße des Inhalts. |
| queryId | Zeichenfolge | Erforderlich | Kennung der auszuführenden Abfrage. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
GET_CONTENT_PART_PROPERTIES
Minimale kompatible Version: CFS V3
Die GET_CONTENT_PART_PROPERTIES-Aktion liefert eine Liste von Metadaten für einen gegebenen Inhaltsbestandteil. Die zurückgegebene Liste enthält den MIME-Typ, die Größe und die Seitenanzahl. Dies kann nützlich sein, um große TIFFs oder mehrteilige Dokumente aufzubrechen. Es kann auch nützlich für Abläufe sein, die darauf angewiesen sind, die Eingabestruktur der Inhaltsbestandteile zu kennen.
Die Eingabeparameter der Aktion sind:
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| contentId | Zeichenfolge | Erforderlich | Die ID des Inhaltsbestandteils, für den die Eigenschaften abgerufen werden sollen |
| offset | Zeichenfolge | Optional | Seitenoffset zur Paginierung |
| pageSize | Zeichenfolge | Optional | Seitengröße für den Inhalt |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgte |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System mit einer Liste der verfügbaren Inhaltsbestandteile und ihrer Eigenschaften. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
READ_CONTENTTYPE_GROUPS
Minimale kompatible Version: CFS V2
Die Aktion READ_CONTENTTYPE_GROUPS wird verwendet, um Daten aus allen bestehenden Inhaltstypengruppen zu lesen, ist jedoch nur auf ihre Bezeichner und Namen beschränkt.
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
Standardwert |
|---|---|---|---|---|
| offset | Zeichenfolge | Optional | Seiten‑Offset für die Paginierung. | k. A. |
| operator | Zeichenfolge | Optional | Typ der Operation. | "Suche" |
| pageSize | Zeichenfolge | Optional | Seitengröße des Inhalts. | k. A. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. | k. A. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
GET_OBJECT_QUERY_DETAILS
Minimale kompatible Version: CFS V2
Die Aktion GET_OBJECT_QUERY_DETAILS bietet detaillierte Informationen über eine bestimmte Suchabfrage. Sie umfasst alle Felder (betrachten Sie sie als Spalten in einer Tabelle), die in der Abfrage verwendet werden können.
Dies kann mit EXECUTE_OBJECT_QUERY verwendet werden, um eine Suche mit definierten Suchparametern auszuführen.
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| queryId | Zeichenfolge | Erforderlich | Bezeichner der Abfrage, deren Details gelesen werden sollen. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
READ_CONTENTTYPE_DEFINITION
Minimale kompatible Version: CFS V2
Die Aktion READ_CONTENTTYPE_DEFINITION wird verwendet, um die Definition eines Inhaltstyps zu lesen, der in einem anderen System konfiguriert wurde.
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
Standardwert |
|---|---|---|---|---|
| contentTypeId | Zeichenfolge | Erforderlich | Bezeichner eines Inhaltstyps, der gelesen werden soll. | k. A. |
| operator | Zeichenfolge | Optional | Typ der Aktivität. | "Suche" |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. | k. A. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |
READ_CONTENT_BINARY
Minimale kompatible Version: CFS V2
Die Aktion READ_CONTENT_BINARY ruft die Binärdaten eines Inhaltsobjekts ab und ermöglicht den Zugriff auf die Rohdatei oder den Inhalt selbst (wie Bilder, PDFs und Audiodateien).
Die Eingabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| contentId | Zeichenfolge | Erforderlich | Bezeichner des Inhalts, der gelesen werden soll. |
| mimeType | Zeichenfolge | Erforderlich | MIME-Typ des Inhalts, der gelesen werden soll. |
| task | Zeichenfolge | Optional | Bezeichner der vorherigen Aufgabe, deren Daten abgerufen werden, wenn die Autorisierung im Namen dieser Aufgabe erfolgt ist. |
Die Ausgabeparameter der Aktion sind:
|
Parameter |
Typ |
Erforderlich |
Beschreibung |
|---|---|---|---|
| result | JSON | Optional | Eine Antwort vom System. Der Inhalt des Ergebnisses kann als Daten für die Eingabeparameter einer anderen Aktion verwendet werden. |