Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

Info

Auf dieser Seite sind die REST-API-Aufrufe beschrieben, die benötigt werden, um programmatisch Prozesslandkarten anzulegen, die einzig aus einem großformatigen "Hintergrundbild" bestehen. 

Diese Prozesslandkarten können genutzt werden, um Prozessmodelle, die mit Drittanbieter-Software erzeugt wurden und die als Grafik-Datei vorliegen, innerhalb der Prozessplattform für Leser auf einfache Weise zugänglich zu machen. 

Erstellen eines neuen Prozessregister-Eintrags für eine Prozesslandkarte 

Request 

POST https://www{host_id}.prozessplattform.de/{tenant}/rest/register/workspace/{workspace_uuid}/action/createProcessMap

...

Status
subtletrue
colourYellow
titlepersönlicher Login

Request-Parameter

Parameter-TypNameBedeutung
Pathhost_idHost-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88")
PathtenantName des Mandanten (z.B. "musterhausen")
Pathworkspace_uuidUUID des Arbeitsbereichs, innerhalb dessen die Prozesslandkarte gespeichert werden soll
Cookie (Header)JSESSIONIDID einer authentifizierten HTTP-Session (muss zu einem Benutzerkonto gehören, das über Schreibrechte für den angegebenen Ordner verfügt)
FormnameName der anzulegenden Prozesslandkarte
FormdirectoryUUID des Verzeichnisses, innerhalb dessen die Prozesslandkarte angelegt werden soll ("root" für das Wurzelverzeichnis des Arbeitsbereichs)

Encoding für Request-Body: "Content-Type: application/x-www-form-urlencoded; charset=UTF-8")

Reponse

  • Header: HTTP-Status-Code 200 ("ok")
  • Body: JSON-Objekt vom Typ "RegisterEntry" (enthält u.a. in der Property "uuid" die UUID des Prozessregister-Eintrags der soeben erzeugten Prozesslandkarte, die zur Adressierung der Prozesslandkarte in Webservice-Aufrufen benötigt wird)

Hochladen einer neuen Datei (zur späteren Verwendung als Dateianhang in einem Steckbrief, einem Prozessmodell oder einer Prozesslandkarte)

Request

POST https://www{host_id}.prozessplattform.de/{tenant}/rest/files/workspace/{workspace_uuid}

...

Status
subtletrue
colourYellow
titlepersönlicher Login

Request-Parameter

Parameter-TypNameBedeutung
Pathhost_idHost-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88")
PathtenantName des Mandanten (z.B. "musterhausen")
Pathworkspace_uuidUUID des Arbeitsbereichs, innerhalb dessen die Prozesslandkarte gespeichert werden soll
Cookie (Header)JSESSIONIDID einer authentifizierten HTTP-Session (muss zu einem Benutzerkonto gehören, das über Schreibrechte für den angegebenen Ordner verfügt)
Body
Inhalt der hochzuladenden Datei (Encoding: multipart/form-data)

Reponse

  • Header: HTTP-Status-Code 200 ("ok")
  • Body: JSON-Objekt vom Typ "FileLink" (Enthält u.a. in der Property "url" den Dateinamen, unter dem die hochgeladene Datei im zentralen Ablage-Verzeichnis für die in diesen Mandanten hochgeladenen Dateien abgelegt ist. Dieser Dateiname wird benötigt, um aus dem u.g. JSON-Dokument zur Repräsentation der Prozesslandkarte auf diese Datei zu referenzieren.)


Speichern einer neuen Version einer Prozesslandkarte 

Request

PUT https://www{host_id}.prozessplattform.de/{tenant}/rest/repository/workspace/{workspace_uuid}/entry/{entry_uuid}/processMap

...

Status
subtletrue
colourYellow
titlepersönlicher Login

Request-Parameter

Parameter-TypNameBedeutung
Pathhost_idHost-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88")
PathtenantName des Mandanten (z.B. "musterhausen")
Pathworkspace_uuidUUID des Arbeitsbereichs, innerhalb dessen die Prozesslandkarte gespeichert werden soll
Pathentry_uuidUUID der Prozesslandkarte (muss eindeutig sein innerhalb des Arbeitsbereichs)
Cookie (Header)JSESSIONIDID einer authentifizierten HTTP-Session (muss zu einem Benutzerkonto gehören, das über Schreibrechte für den angegebenen Ordner verfügt)
FormrevisionDataBase64-Codiertes und ZIP-komprimiertes JSON-Dokument der Prozesslandkarte (Name der JSON-Datei innerhalb des ZIP-Archivs: "model.json"; Struktur der JSON-Datei: siehe /wiki/spaces/pppdoc300/pages/636715619)

Encoding für Request-Body: "Content-Type: application/x-www-form-urlencoded; charset=UTF-8"

Reponse

  • Header: HTTP-Status-Code 201 ("created")
  • kein Response-Body-Content