Auflistung der Inhalte eines Ordners (Prozesse & Prozesslandkarten)
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/find/processes/directory/{directoryUUID}
Nutzungsvoraussetzungen
Dieser API-Endpunkt steht nur zur Verfügung, wenn für den jeweiligen Prozessplattform-Mandanten das Portal-Modul lizensiert ist.
Möglichkeiten zur Authentifizierung & Autorisierung
PERSÖNLICHER LOGIN
Request-Parameter
Parameter-Typ | Name | Bedeutung |
|---|---|---|
Path | hostid | Host-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88") |
Path | tenant | Name des Mandanten (z.B. "musterhausen") |
Path | workspaceUUID | UUID des Arbeitsbereichs |
Path | directoryUUID | UUID des abzufragenden Ordners (die ID des Wurzelordners ist "root") |
Cookie (Header) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Response
JSON-Array mit den Namen aller direkten Unterordner und allen Einträgen des Ordners (Datenstruktur: Array von RepositoryEntry-Objekten)
Auflistung der aktuellen Treffermenge eines (Prozessregister-)Filterbündels
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/find/processes/filterBundle/{filterBundleUUID}
Nutzungsvoraussetzungen
Dieser API-Endpunkt steht nur zur Verfügung, wenn für den jeweiligen Prozessplattform-Mandanten das Portal-Modul lizensiert ist.
Möglichkeiten zur Authentifizierung & Autorisierung
PERSÖNLICHER LOGIN
Request-Parameter
Parameter-Typ | Name | Bedeutung |
|---|---|---|
Path | hostid | Host-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88") |
Path | Name des Mandanten (z.B. "musterhausen") | |
Path | workspaceUUID | UUID des Arbeitsbereichs |
Path | filterBundleUUID | UUID des abzurufenden Filterbündels |
Cookie (Header) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Response
JSON-Array mit allen Einträgen, die den Kriterien des Filterbündels entsprechen (Datenstruktur: Array von RepositoryEntry-Objekten)
Auflistung der Prozessregistereinträge, die in einer Freigabe enthalten sind
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/share/{shareToken}/iframelist
Nutzungsvoraussetzungen
Dieser API-Endpunkt steht nur zur Verfügung, wenn für den jeweiligen Prozessplattform-Mandanten das Portal-Modul lizensiert ist.
Möglichkeiten zur Authentifizierung & Autorisierung
SHARE TOKEN (FREIGABE)
Request-Parameter
Parameter-Typ | Name | Bedeutung |
|---|---|---|
Path | hostid | Host-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88") |
Path | Name des Mandanten (z.B. "musterhausen") | |
Path | shareToken | Token, das zum Zugriff auf die hierdurch identifizierte Portal-Freigabe Freigabe berechtigt (kann dem über die Benutzeroberfläche generierten Freigabe-Link entnommen werden) |
Response
JSON-Array mit allen Prozessregistereinträgen, die in der Freigabe enthalten sind (Datenstruktur: Array von PortalList-Objekten)
Spezielle Fehler-Codes
400 (Bad Request): Im Falle, dass die Anfrage nicht aus dem in der Freigabe hinterlegten IP-Adressbereich stammt, die Freigabe defekt, abgelaufen oder nicht mehr vorhanden ist
Schlagwortsuche nach Prozessregister-Einträgen
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/find/processes?searchTerm={searchTerm}
Nutzungsvoraussetzungen
Dieser API-Endpunkt steht nur zur Verfügung, wenn für den jeweiligen Prozessplattform-Mandanten das Portal-Modul lizensiert ist.
Möglichkeiten zur Authentifizierung & Autorisierung
PERSÖNLICHER LOGIN
Request-Parameter
Parameter-Typ | Name | Bedeutung |
|---|---|---|
Path | hostid | Host-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88") |
Path | tenant | Name des Mandanten (z.B. "musterhausen") |
Path | workspaceUUID | UUID des Arbeitsbereichs |
Query | searchTerm | Suchbegriff (Name / Schlagwort bzw. ein Teil davon) Achtung: der hier angegebene Wert muss "urlencoded" sein, da er als Query-Parameter benutzt wird! |
Cookie (Header) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Response
JSON-Array mit allen Einträgen, deren Bezeichnung oder Schlagworte den Suchbegriff enthalten (Datenstruktur: Array von RepositoryEntry-Objekten).
Schlagwortsuche nach Prozessregister-Einträgen (Volltextsuche)
Diese Schnittstelle ist nur verfügbar, sofern der jeweilige Prozessplattform-Mandant am Pilot-Betrieb der Volltextsuche teilnimmt.
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/search?searchTerm={searchTerm}?types={types}
Nutzungsvoraussetzungen
Dieser API-Endpunkt steht nur zur Verfügung, wenn für den jeweiligen Prozessplattform-Mandanten die Volltextsuche lizensiert ist.
Möglichkeiten zur Authentifizierung & Autorisierung
PERSÖNLICHER LOGIN
Request-Parameter
Parameter-Typ | Name | Bedeutung |
|---|---|---|
Path | hostid | Host-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88") |
Path | tenant | Name des Mandanten (z.B. "musterhausen") |
Path | workspaceUUID | UUID des Arbeitsbereichs |
Query | searchTerm | Suchbegriff (Name / Schlagwort bzw. ein Teil davon) Achtung: der hier angegebene Wert muss "urlencoded" sein, da er als Query-Parameter benutzt wird! |
Query | types | Suchtypen (Prozesse, Prozesskontext, Filterbündel) |
Response
JSON-Array mit allen Einträgen, deren Bezeichnung oder Schlagworte den Suchbegriff in Verbindung mit dem Typ enthalten (Datenstruktur: Array von RepositoryEntry-Objekten).
Spezielle Fehler-Codes
400 (Bad Request): Im Falle, dass Volltextsuche im Prozessplattform-Mandanten nicht lizensiert ist.
Schlagwortsuche nach Freigabe-Inhalten
Nutzungsvoraussetzungen
Dieser API-Endpunkt steht nur zur Verfügung, wenn für den jeweiligen Prozessplattform-Mandanten das Portal-Modul lizensiert ist.
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/share/{shareToken}/portalSearch/{searchTerm}
Möglichkeiten zur Authentifizierung & Autorisierung
SHARE TOKEN (FREIGABE)
Request-Parameter
Parameter-Typ | Name | Bedeutung |
|---|---|---|
Path | hostid | Host-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88") |
Path | Name des Mandanten (z.B. "musterhausen") | |
Path | shareToken | Token, das zum Zugriff auf die hierdurch identifizierte Portal-Freigabe Freigabe berechtigt (kann dem über die Benutzeroberfläche generierten Freigabe-Link entnommen werden) |
Path | searchTerm | Suchbegriff (Name / Schlagwort bzw. ein Teil davon) Achtung: der hier angegebene Wert muss "urlencoded" sein, da er als Path-Parameter benutzt wird! |
Response
JSON-Array mit allen Einträgen, deren Bezeichnung oder Schlagworte den Suchbegriff enthalten (Datenstruktur: Array von PortalEntry-Objekten)
Spezielle Fehler-Codes
400 (Bad Request): Im Falle, dass die Anfrage nicht aus dem in der Freigabe hinterlegten IP-Adressbereich stammt, die Freigabe defekt, abgelaufen oder nicht mehr vorhanden ist
Schlagwortsuche nach Freigabe-Inhalten (Volltextsuche)
Diese Schnittstelle ist nur verfügbar, sofern der jeweilige Prozessplattform-Mandant am Pilot-Betrieb der Volltextsuche teilnimmt.
Nutzungsvoraussetzungen
Dieser API-Endpunkt steht nur zur Verfügung, wenn für den jeweiligen Prozessplattform-Mandanten das Portal-Modul und die Volltextsuche lizensiert ist.
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/share/{shareToken}/portalSearch/search/{searchTerm}
Möglichkeiten zur Authentifizierung & Autorisierung
SHARE TOKEN (FREIGABE)
Request-Parameter
Parameter-Typ | Name | Bedeutung |
|---|---|---|
Path | hostid | Host-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88") |
Path | Name des Mandanten (z.B. "musterhausen") | |
Path | shareToken | Token, das zum Zugriff auf die hierdurch identifizierte Portal-Freigabe Freigabe berechtigt (kann dem über die Benutzeroberfläche generierten Freigabe-Link entnommen werden) |
Path | searchTerm | Suchbegriff (Name / Schlagwort bzw. ein Teil davon) Achtung: der hier angegebene Wert muss "urlencoded" sein, da er als Path-Parameter benutzt wird! |
Response
JSON-Array mit allen Einträgen, deren Bezeichnung oder Schlagworte den Suchbegriff enthalten (Datenstruktur: Array von PortalEntry-Objekten)
Spezielle Fehler-Codes
400 (Bad Request): Im Falle, dass Volltextsuche im Prozessplattform-Mandanten nicht lizensiert ist.
Abrufen einer Prozesskontext-Baumstruktur
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/processContext/tree/{type}
Möglichkeiten zur Authentifizierung & Autorisierung
PERSÖNLICHER LOGIN
Request-Parameter
Parameter-Typ | Name | Bedeutung |
|---|---|---|
Path | hostid | Host-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88") |
Path | tenant | Name des Mandanten (z.B. "musterhausen") |
Path | workspaceUUID | UUID des Arbeitsbereichs |
Path | type | Typ des Prozesskontextes. Mögliche Werte:
|
Cookie (Header) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Response
JSON-Array mit den (geschachtelten) Baumknoten (Datenstruktur: Array von TreeNode-Objekten). Das Array enthält die Baum-Knoten auf Wurzel-Ebene (die Datenstruktur lässt mehrere Wurzeln zu).