Veraltete Endpunkte
- Former user (Deleted)
- Malte Stockmann
Auf dieser Seite sind Endpunkte der REST-API dokumentiert, die in der aktuellen Version der PICTURE-Prozessplattform aus Gründen der Abwärtskompatibilität noch enthalten sind, die aber in künftigen Releases wegfallen werden.
Für neue Entwicklungsvorhaben sollten diese Endpunkte nicht mehr verwendet werden. Bestehende Client-Anwendungen sollten rechtzeitig angepasst werde, so dass beim Update auf eine PPP-Version, in der diese Endpunkte nicht mehr enthalten sind, keine Beeinträchtigungen der Funktionalität auftreten. Für jeden wegfallenden Endpunkt werden auf dieser Seite die künftig empfohlenen Alternativen genannt.
Zugriff auf Portal-Freigaben mittels "Share Token"
Freigaben
Eine Freigabe in der Prozessplattform umfasst eine Liste von Prozessen / Prozesslandkarten. Die Authentifizierung des Zugriffs erfolgt über das Share Token der Freigabe, welches den Query-Parametern (&shareToken=...) des zugehörigen Freigabelinks entnommen werden kann.
Der Zugriff auf die Freigabe kann in der Prozessplattform per Whitelisting auf bestimmte IP-Adressbereiche begrenzt werden.
Abrufen des Kurzsteckbriefs zu einem Element
GET https://www{hostid}.prozessplattform.de/{tenant}/rest/share/{shareToken}/quickInfo/{targetType}/{elementUUID}
| Parameter | shareToken targetType elementUUID | Token, das dem Freigabe-Link entnommen werden kann Typ des Elements (z.B. type aus Suchergebnis) UUID des Elements (z.B. id aus Suchergebnis) |
|---|---|---|
| Login erforderlich? | nein | Authentifizierung erfolgt über shareToken |
| Rückgabe | JSON-Objekt zur Darstellung der Kurzinformationen zum Element | ElementQuickInfo-Objekt |
Deprecated seit v3.1.24. Erste Version ohne diesen Endpunkt: v3.2.0. Die Umstellung vorhandener Clients, welche diesen Endpunkt nutzen, sollte bis zum 31.12.2018 abgeschlossen sein.
Nachfolger-Endpunkt: Informationsobjekte auslesen (Details) => Steckbrief
Spezielle Fehlercodes
| HTTP-Response-Code | mögliche Fehlerursache |
|---|---|
| 400 | ungültiges Token |
| 403 | Der angefragte Inhalt ist nicht Teil der Freigabe |
| 404 | Zur angefragten ID liegt kein Inhalt (mehr) vor |