Seitenvergleich

Auflistung der Inhalte eines Ordners (Prozesse & Prozesslandkarten)

Request 

GET https://www{hostid}.prozessplattform.de/{tenant}/rest/repository/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

Request-Parameter 

...

Name

...

Bedeutung

...

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/repository/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

Request-Parameter 

...

Name

...

UUID des abzurufenden Filterbündels

...

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

Request-Parameter 

...

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/repository/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

Request-Parameter 

...

Suchbegriff (Name / Schlagwort bzw. ein Teil davon)

Achtung: der hier angegebene Wert muss "urlencoded" sein, da er als Query-Parameter benutzt wird!

...

Response 

• JSON-Array mit allen Einträgen, deren Bezeichnung oder Schlagworte den Suchbegriff enthalten (Datenstruktur: Array von RepositoryEntry-Objekten).

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

Request-Parameter 

...

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 

Abrufen einer Prozesskontext-Baumstruktur

Request 

GET https://www{hostid}.prozessplattform.de/{tenant}/rest/repository/workspace/{workspaceUUID}/processContext/tree/{type}

Möglichkeiten zur Authentifizierung & Autorisierung 

Request-Parameter 

...

workspaceUUID

...

UUID des Arbeitsbereichs

...

Typ des Prozesskontextes.

Mögliche Werte:

• Organisation
• Product
• Software
• Hardware
• Document
• Rule
• ExternalParticipant
• Person
• SalaryBracket

...

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).