Sie können vom PPM-Server eine Liste der für Sie freigegebenen Favoriten anfragen. Die Liste wird in Form einer XML-Datei zurückgegeben, die für jeden exportierten Favoriten folgende Informationen enthält:
Bei der Anfrage werden nur Favoriten und Favoritenordner berücksichtigt, die im aktuell angefragten Ordner liegen. In Unterordnern liegende Favoriten und Favoritenordner werden nicht berücksichtigt. Eine Anfrage liefert alle Favoriten, die auf beliebigen Diagrammtypen, EPK-Ansichten, Kommunikationsanalysen oder Analysen des Relationexplorers basieren.
Es wird ein XML-Datenstrom zurückgeliefert, der wie folgt strukturiert ist:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE favoritequeryresult SYSTEM "http://localhost:8080/API_umg_en/dtd/queryapifavorites.dtd">
<favoritequeryresult>
<data>
<favoritenode favoritetype="FOLDER" name="..." path="..."
full-path="..." urlencoded-path="..."/>
...
<favoritenode favoritetype="FAVORITE" name="..." querytype="..."
path="..." full-path="..." urlencoded-path="..."/>
...
</data>
</favoritequeryresult>
Die Informationen werden als XML-Attributwerte angegeben.
XML-Attribut |
Beschreibung |
path |
Pfad des Favoriten. Die Angabe erfolgt ohne Maskierung von Zeichen. |
name |
Name des Favoriten bzw. Favoritenordners. Die Angabe erfolgt ohne Maskierung von Zeichen. |
full-path |
Vollständiger Pfad des Favoriten, der auch den Favoritennamen enthält. Als Trennzeichen zwischen den Pfadelementen werden die Zeichen / oder \ verwendet. Innerhalb der Namen der Pfadelemente werden die Zeichen / und \ maskiert, d.h. / wird als // und \ als \\ ausgegeben. |
urlencoded-path |
Pfad und Name des Favoriten. Die Angabe erfolgt maskiert (s. full-path) und URL-kodiert, d.h. Sonderzeichen sind durch spezielle Zeichenfolgen ersetzt (z. B. \ durch %5C). |
querytype |
Abfragetyp des Favoriten. Mögliche Werte: CHART: Favorit basierend auf Diagrammen (2D, 3D, Assesment, Gantt) GRAPH: Favorit basierend auf EPK-Ansicht, Kommunikationsanalyse und Relation Explorer TABLE: Favorit basierend auf Tabellen und Process Mining. INSTANCELIST: Favoriten basierend auf Instanzliste, Alarmwertanalyse, Prozessinstanzsuche, Frühwarnsystem und Außreiseranalyse. Wird nur ausgegeben, wenn das Ergebnis ein Favorit ist. |
favoritetype |
Das Ergebnis ist ein Favoritenordner (Wert FOLDER) oder ein Favorit (Wert FAVORITE). |
Die Abfrage berücksichtigt nur normale Favoriten und Konfigurationsfavoriten. Template und Multianalyse-Favoriten werden nicht berücksichtigt.
Anfrageschema
http://host:port/contextname/urlquery/favorites/query.do?parameterliste
Beispiel
http://localhost:8080/API_demo41_en/urlquery/favorites/query.do?path=<Favoritepath>
Wenn Sie die Abfrageschnittstelle aktiviert haben, können Sie in PPM den Kontextmenüeintrag URL für Abfrageschnittstelle eines bestimmten Favoritenordners verwenden, um die entsprechende URL in die Zwischenablage zu kopieren. Die erzeugte URL ist bereits korrekt kodiert und enthält im Argument language die Sprache, die beim Anmelden am PPM-Frontend angegeben wurde.
Folgende optionalen Parameter werden unterstützt:
Parameter |
Beschreibung |
path |
Pfad des Startknotens, ab dem Favoriten gesucht werden. Fehlt die Angabe, werden abhängig vom Wert favoritefolder alle privaten oder öffentlichen Favoriten gesucht. |
querytype |
Abfragetyp. Mögliche Werte: CHART: Favoriten basierend auf Diagrammen (2D, 3D, Assesment, Gantt) GRAPH: Favoriten basierend auf EPK-Ansicht, Kommunikationsanalyse und Relation Explorer TABLE: Favoriten basierend auf Tabellen und Process Mining. INSTANCELIST: Favoriten basierend auf Instanzliste, Alarmwertanalyse, Prozessinstanzsuche, Frühwarnsystem und Außreiseranalyse. Ist querytype nicht angegeben, werden alle Abfragetypen geliefert. Sie können nach mehreren Abfragetypen suchen, indem Sie eine Liste der Abfragetypen durch Semikolon getrennt angeben. |
favoritetype |
Bestimmt, ob nur Favoritenordner (Wert FOLDER) oder nur Favoriten (Wert FAVORITE) zurück gegeben werden. Fehlt die Angabe, werden Favoriten und Ordner zurückgegeben. |
favoritefolder |
Bestimmt, ob private (FAVORITES_PRIVATE) oder öffentliche (FAVORITES_SHARED) angefragt werden sollen. |
language (optional) |
Bestimmt die Sprache zur Ausgabe von Fehlermeldungen. Fehlt die Angabe, werden Fehlermeldungen in der Sprache ausgegeben, mit der der PPM-Server gestartet wurde. |
Die Angaben für querytype, favoritetype und favoritefolder müssen in Großschreibweise erfolgen.
Fehlermeldungen
Wenn eine Anfrage nicht korrekt ausgeführt werden kann, wird anstelle des XML-Elements data ein XML-Element error ausgegeben. In PCDATA ist der Text und im Attribut id der Identifizierer des Fehlers angegeben.