Informationsobjekte auslesen (Details)
- Former user (Deleted)
- Malte Stockmann
- Dennis Kindervater
- 1 Abrufen des Kurzsteckbriefs zu einem Informationsobjekt (Prozess, Prozesslandkarte, Prozesskontext-Element)
- 2 Abrufen eines Prozesssteckbriefs im PicXML 3-Format
- 3 Abrufen eines Prozesskontextelementsteckbriefs im PicXML 3-Format
- 4 Abrufen der Verwendungsnachweise zu einem Informationsobjekt (Prozesskontext-Element)
- 5 Abrufen von Dateianhängen
- 6 Abrufen von PDF-Exporten
Abrufen des Kurzsteckbriefs zu einem Informationsobjekt (Prozess, Prozesslandkarte, Prozesskontext-Element)
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/quickInfo/{targetType}/{uuid}?attributeViewUUID={attributeViewUUID}
Möglichkeiten zur Authentifizierung & Autorisierung
persönlicher Login, 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 | tenant | Name des Mandanten (z.B. "musterhausen") |
Path | workspaceUUID | UUID des Arbeitsbereichs Achtung: Bei einem Zugriff per ShareToken, wird die als Path-Parameter angegeben UUID des Arbeitsbereiches nicht ausgewertet, stattdessen wird die in der Portal-Freigabe hinterlegte Arbeitsbereich-UUID ausgewertet. Wir empfehlen daher bei einem Zugriff per ShareToken einen einheitlichen Dummy-Wert (z.B. "share") als Path-Parameter "workspaceUUID" anzugeben. |
Path | targetType | Typ des Informationsobjekts (z.B. type aus Suchergebnis) Mögliche Werte:
|
Path | uuid | UUID des Informationsobjekts (z.B. id aus Suchergebnis) |
Query (optional **) | attributeViewUUID | UUID der anzuwenden Attributsicht |
Cookie (Header, optional *) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Query (optional *) | shareToken | Token, das zum Zugriff auf die hierdurch identifizierte Portal-Freigabe Freigabe berechtigt (kann dem über die Benutzeroberfläche generierten Freigabe-Link entnommen werden) |
*) Es muss entweder der Cookie-Header (für die Authentifizierung mit einem persönlichen Benutzerkonto) oder der Query-Parameter "shareToken" (für den anonymen Zugriff per Portal-Freigabe) übermittelt werden.
**) Wenn die Authentifizierung per ShareToken erfolgt, wird der Query-Parameter "attributeViewUUID" nicht benötigt, da bei der Erstellung der zugehörigen Portal-Freigabe genau eine Sicht festgelegt wird, die über die Freigabe exponiert wird. Wird der Query-Parameter "attributeViewUUID" bei einem Zugriff per ShareToken trotzdem angegeben wird er nicht ausgewertet, es wird in jedem Fall die in der Portal-Freigabe festgelegte Sicht angewendet. Wenn die Authentifizierung mit einem persönlichen Login bzw. JSESSIONID erfolgt, kann mit Hilfe des Query-Parameter "attributeViewUUID" die anzuwendende Sicht festgelegt werden. Wird der Query-Parameter "attributeViewUUID" bei einem Zugriff per persönlichem Login bzw. JSESSIONUD weggelassen wird oder keine Sicht mit der übergebenen UUID existiert, so werden die Attribute aus allen Sichten berücksichtigt, welche für den eingeloggten Benutzer freigeschaltet sind.
Response
JSON-Objekt zur Darstellung der Kurzinformationen zum Element (Datenstruktur: ElementQuickInfo-Objekt)
Spezielle Fehler-Codes
400 (Bad Request): Im Falle, dass die Anfrage bei der ein ShareToken als Query-Parameter übergeben wurde nicht aus dem in der Freigabe hinterlegten IP-Adressbereich stammt, die Freigabe defekt, abgelaufen oder nicht mehr vorhanden ist
Abrufen eines Prozesssteckbriefs im PicXML 3-Format
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/process/{processUUID}/factSheet/representation/xml?attributeViewUUID={attributeViewUUID}
Möglichkeiten zur Authentifizierung & Autorisierung
persönlicher Login, 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 | tenant | Name des Mandanten (z.B. "musterhausen") |
Path | workspaceUUID | UUID des Arbeitsbereichs Achtung: Bei einem Zugriff per ShareToken, wird die als Path-Parameter angegeben UUID des Arbeitsbereiches nicht ausgewertet, stattdessen wird die in der Portal-Freigabe hinterlegte Arbeitsbereich-UUID ausgewertet. Wir empfehlen daher bei einem Zugriff per ShareToken einen einheitlichen Dummy-Wert (z.B. "share") als Path-Parameter "workspaceUUID" anzugeben. |
Path | processUUID | UUID des Prozesses |
Query (optional **) | attributeViewUUID | UUID der anzuwenden Attributsicht |
Cookie (Header, optional *) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Query (optional *) | shareToken | Token, das zum Zugriff auf die hierdurch identifizierte Portal-Freigabe Freigabe berechtigt (kann dem über die Benutzeroberfläche generierten Freigabe-Link entnommen werden) |
*) Es muss entweder der Cookie-Header (für die Authentifizierung mit einem persönlichen Benutzerkonto) oder der Query-Parameter "shareToken" (für den anonymen Zugriff per Portal-Freigabe) übermittelt werden.
**) Wenn die Authentifizierung per ShareToken erfolgt, wird der Query-Parameter "attributeViewUUID" nicht benötigt, da bei der Erstellung der zugehörigen Portal-Freigabe genau eine Sicht festgelegt wird, die über die Freigabe exponiert wird. Wird der Query-Parameter "attributeViewUUID" bei einem Zugriff per ShareToken trotzdem angegeben wird er nicht ausgewertet, es wird in jedem Fall die in der Portal-Freigabe festgelegte Sicht angewendet. Wenn die Authentifizierung mit einem persönlichen Login bzw. JSESSIONID erfolgt, kann mit Hilfe des Query-Parameter "attributeViewUUID" die anzuwendende Sicht festgelegt werden. Wird der Query-Parameter "attributeViewUUID" bei einem Zugriff per persönlichem Login bzw. JSESSIONUD weggelassen wird oder keine Sicht mit der übergebenen UUID existiert, so werden die Attribute aus allen Sichten berücksichtigt, welche für den eingeloggten Benutzer freigeschaltet sind.
Response
XML-Repräsentation des Prozesssteckbrief (Datenstruktur: PicXML 3 - Dokument)
Spezielle Fehler-Codes
400 (Bad Request): Im Falle, dass die Anfrage bei der ein ShareToken als Query-Parameter übergeben wurde nicht aus dem in der Freigabe hinterlegten IP-Adressbereich stammt, die Freigabe defekt, abgelaufen oder nicht mehr vorhanden ist
Abrufen eines Prozesskontextelementsteckbriefs im PicXML 3-Format
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/{type}/{uuid}/factSheet/representation/xml?attributeViewUUID={attributeViewUUID}
Möglichkeiten zur Authentifizierung & Autorisierung
persönlicher Login, 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 | tenant | Name des Mandanten (z.B. "musterhausen") |
Path | workspaceUUID | UUID des Arbeitsbereichs Achtung: Bei einem Zugriff per ShareToken, wird die als Path-Parameter angegeben UUID des Arbeitsbereiches nicht ausgewertet, stattdessen wird die in der Portal-Freigabe hinterlegte Arbeitsbereich-UUID ausgewertet. Wir empfehlen daher bei einem Zugriff per ShareToken einen einheitlichen Dummy-Wert (z.B. "share") als Path-Parameter "workspaceUUID" anzugeben. |
Path | type | Typ des Prozesskontexts Mögliche Werte:
|
Path | uuid | UUID des Prozesskontextelements |
Query (optional **) | attributeViewUUID | UUID der anzuwenden Attributsicht |
Cookie (Header, optional *) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Query (optional *) | shareToken | Token, das zum Zugriff auf die hierdurch identifizierte Portal-Freigabe Freigabe berechtigt (kann dem über die Benutzeroberfläche generierten Freigabe-Link entnommen werden) |
*) Es muss entweder der Cookie-Header (für die Authentifizierung mit einem persönlichen Benutzerkonto) oder der Query-Parameter "shareToken" (für den anonymen Zugriff per Portal-Freigabe) übermittelt werden.
**) Wenn die Authentifizierung per ShareToken erfolgt, wird der Query-Parameter "attributeViewUUID" nicht benötigt, da bei der Erstellung der zugehörigen Portal-Freigabe genau eine Sicht festgelegt wird, die über die Freigabe exponiert wird. Wird der Query-Parameter "attributeViewUUID" bei einem Zugriff per ShareToken trotzdem angegeben wird er nicht ausgewertet, es wird in jedem Fall die in der Portal-Freigabe festgelegte Sicht angewendet. Wenn die Authentifizierung mit einem persönlichen Login bzw. JSESSIONID erfolgt, kann mit Hilfe des Query-Parameter "attributeViewUUID" die anzuwendende Sicht festgelegt werden. Wird der Query-Parameter "attributeViewUUID" bei einem Zugriff per persönlichem Login bzw. JSESSIONUD weggelassen wird oder keine Sicht mit der übergebenen UUID existiert, so werden die Attribute aus allen Sichten berücksichtigt, welche für den eingeloggten Benutzer freigeschaltet sind.
Response
XML-Repräsentation des Steckbrief des Prozesskontextelements (Datenstruktur: PicXML 3 - Dokument)
Spezielle Fehler-Codes
400 (Bad Request): Im Falle, dass die Anfrage bei der ein ShareToken als Query-Parameter übergeben wurde nicht aus dem in der Freigabe hinterlegten IP-Adressbereich stammt, die Freigabe defekt, abgelaufen oder nicht mehr vorhanden ist
Abrufen der Verwendungsnachweise zu einem Informationsobjekt (Prozesskontext-Element)
Request
POST https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/{processContextType}/processContextReferences
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 | processContextType | Typ des Prozesskontexts Mögliche Werte:
|
Cookie (Header*) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Form | uuid | UUID des Prozesskontext-Elements |
Form | includeChildren | Sofern Kindelemente des angegebenen Prozesskontextelements in anderen Informationsobjekten referenziert werden, werden diese Informationsobjekten ebenfalls aufgelistet. Mögliche Werte:
|
*) Es muss der Cookie-Header (für die Authentifizierung mit einem persönlichen Benutzerkonto) übermittelt werden.
Response
Ein JSON-Array von JSON-Objekten vom Typ ProcessContextElementReferencedGroup, welche alle Prozesse, Prozesslandkarten und Prozesskontext-Elemente enthält, in denen das angegebene Prozesskontext-Element (ggf. inkl. Kindelemente) referenziert wird.
Spezielle Fehler-Codes
401 (Unauthorized): Sollten Sie nicht eingeloggt sein
403 (Forbidden): Sollte Sie kein Zugriff auf den Arbeitsbereich haben
403 (Forbidden): Sollten Sie kein Lesezugriff auf das angegebene Prozesskontextelement besitzen
404 (Not found): Sollte der angegebene Arbeitsbereich nicht gefunden werden
404 (Not found): Sollte das angegebenen Prozesskontextelement nicht gefunden werden
Abrufen von Dateianhängen
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/files/fileAttachment/?file={file}&name={name}
Möglichkeiten zur Authentifizierung & Autorisierung
persönlicher Login, 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 | tenant | Name des Mandanten (z.B. "musterhausen") |
Query | file | UUID des Dateianhangs (wird zur Eindeutigen Identifikation der Datei im Dateisystem verwendet) |
Query | name | Dateibezeichnung |
Cookie (Header, optional *) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Query (optional *) | shareToken | Token, das zum Zugriff auf die hierdurch identifizierte Portal-Freigabe Freigabe berechtigt (kann dem über die Benutzeroberfläche generierten Freigabe-Link entnommen werden) |
*) Es muss entweder der Cookie-Header (für die Authentifizierung mit einem persönlichen Benutzerkonto) oder der Query-Parameter "shareToken" (für den anonymen Zugriff per Portal-Freigabe) übermittelt werden.
Response
Der abgerufene Dateianhang
Spezielle Fehler-Codes
400 (Bad Request): Im Falle, dass die Anfrage bei der ein ShareToken als Query-Parameter übergeben wurde nicht aus dem in der Freigabe hinterlegten IP-Adressbereich stammt, die Freigabe defekt, abgelaufen oder nicht mehr vorhanden ist
Abrufen von PDF-Exporten
Request
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/workspace/{workspaceUUID}/entry/{entryUUID}/pdf/{type}
Möglichkeiten zur Authentifizierung & Autorisierung
persönlicher Login, 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 | tenant | Name des Mandanten (z.B. "musterhausen") |
Path | workspaceUUID | UUID des Arbeitsbereichs Achtung: Bei einem Zugriff per ShareToken, wird die als Path-Parameter angegeben UUID des Arbeitsbereiches nicht ausgewertet, stattdessen wird die in der Portal-Freigabe hinterlegte Arbeitsbereich-UUID ausgewertet. Wir empfehlen daher bei einem Zugriff per ShareToken einen einheitlichen Dummy-Wert (z.B. "share") als Path-Parameter "workspaceUUID" anzugeben. |
Path | entryUUID | UUID des Prozesses / der Prozesslandkarte |
Path | type | Typ des PDF-Exportes Mögliche Werte:
|
Query (optional **) | attributeViewUUID | UUID der anzuwenden Attributsicht. (Der Spezial-Wert "Combined" kann für die Attributsicht "(alle Attribute anzeigen)" genutzt werden.) |
Cookie (Header, optional *) | JSESSIONID | ID einer authentifizierten HTTP-Session |
Query (optional *) | shareToken | Token, das zum Zugriff auf die hierdurch identifizierte Portal-Freigabe Freigabe berechtigt (kann dem über die Benutzeroberfläche generierten Freigabe-Link entnommen werden) |
*) Es muss entweder der Cookie-Header (für die Authentifizierung mit einem persönlichen Benutzerkonto) oder der Query-Parameter "shareToken" (für den anonymen Zugriff per Portal-Freigabe) übermittelt werden.
**) Wenn die Authentifizierung per ShareToken erfolgt, wird der Query-Parameter "attributeViewUUID" nicht benötigt, da bei der Erstellung der zugehörigen Portal-Freigabe genau eine Sicht festgelegt wird, die über die Freigabe exponiert wird. Wird der Query-Parameter "attributeViewUUID" bei einem Zugriff per ShareToken trotzdem angegeben wird er nicht ausgewertet, es wird in jedem Fall die in der Portal-Freigabe festgelegte Sicht angewendet. Wenn die Authentifizierung mit einem persönlichen Login bzw. JSESSIONID erfolgt, kann mit Hilfe des Query-Parameter "attributeViewUUID" die anzuwendende Sicht festgelegt werden. Wird der Query-Parameter "attributeViewUUID" bei einem Zugriff per persönlichem Login bzw. JSESSIONUD weggelassen wird oder keine Sicht mit der übergebenen UUID existiert, so werden die Attribute aus der Sicht berücksichtigt, welche zuletzt für den eingeloggten Benutzer ausgewählt wurde.
Response
PDF-Export des angegebenen Prozessregistereintrages im angegebenen Format bzw. Typ
Spezielle Fehler-Codes
400 (Bad Request): Im Falle, dass die Anfrage bei der ein ShareToken als Query-Parameter übergeben wurde nicht aus dem in der Freigabe hinterlegten IP-Adressbereich stammt, die Freigabe defekt, abgelaufen oder nicht mehr vorhanden ist