Ruft die Eigenschaften einer Gruppe von Vorgängen ab, die einem Filter im betreffenden Planer entsprechen.
Abfrage
| Vorgehensweise | URL |
|---|---|
| POST | ROOTVP/ws/rest/event/get |
| Typ | Parameter | Werte |
|---|---|---|
| HEAD | apikey | Zeichenkette |
| DATEN | Attribute | Zeichenkette |
| DATEN | filterName | Zeichenkette |
| DATEN | [extraInfos] | Zeichenkette |
apikey
Der API-Schlüssel des Anwenders (muss in allen Abfragen übermittelt werden). Ruft die WebService für einen bestimmten Anwender und Planer ab.
Attribute
Die abzurufenden Attribute. [„attr1“,…]
Die Attribute werden anhand ihrer Bezeichnung identifiziert, wie sie vom Zugriffspunkt/den Attributen übermittelt werden.
filterName
Name des angewendeten Vorgangsfilters.
extraInfos [optional]
Dynamische Attribute des Filters [{„entityName“: „attr2“, „entityValue“: „value2“}, …].
Antwort
| Status | Mitteilung |
|---|---|
| 0 | |
| 1 | Ungültige Sitzung: apikey |
| 2 | Ungültiger Vorgangsfilter: filterName |
3 Kein Wert für die Variable oder ungültiger Wert für „invalidVariable“
4 Schwerwiegender Fehler: errorMessage
| 5 | Ungültiges Attribut: attribut |
|---|---|
| 6 | Es wurden keine Entitäten gefunden |
| 7 | Exportieren KO |
Beispiel:
Für den Planer „DEMO API REST“, der auf einem Server unter Visual Planning mit dem Stamm-URL http://127.0.0.1:8906/ip50 installiert ist, möchten wir die Attribute Startdatum, Enddatum, Kunde, Projekt, Phase, Aufgabe und Ressourcen aller Vorgänge abrufen, die dem Vorgangsfilter „DYNAMIC REST API DEMO TASK/PROJECT“ entsprechen, der einen dynamischen PROJECT-Parameter für den Projektnamen enthält.
Unter Verwendung des Werts „Projekt 1“ für den dynamischen Parameter PROJECT und mit einem Anwender, dessen Zugriffsschlüssel für die API lautet: d9f79618-59e4-a710-8203-a39bab9ad09b, ergibt sich Folgendes:
URL:
http://127.0.0.1:8906/ip50/ws/rest/event/get
Veröffentlichte Daten:
{
"extraInfos":
[
{"entityValue":"Projet 1","entityName":"PROJET"}
],
„Attribute“:
[
„Vorgang – Startdatum“, „Vorgang – Enddatum“,
„Aufgaben-Kunde“, „Aufgaben-Projekt“,
„Aufgaben-Phase“, „Aufgaben-Aufgabe“, „Ressourcen“
],
„filterName“: „DEMO-API-REST-TACHE/PROJET DYNAMIQUE“
}
Antwort:
{
„Fehler“: 0,
"message":"",
„Entitäten“:
[
[
{"entityName":"Evénement-Date de début","entityValue":"12/03/2018 00:00"},
{"entityName":"Evénement-Date de fin","entityValue":"15/03/2018 00:00"},
{"entityName":"Tâches-Client","entityValue":"Client 1"},
{"entityName":"Tâches-Projet","entityValue":"Projet 1"},
{"entityName":"Tâches-Phase","entityValue":"Phase 1"},
{"entityName":"Tâches-Tâche","entityValue":"Analyse"},
{"entityName":"Ressources","entityValue":""}
],
……..
[
{"entityName":"Evénement-Date de début","entityValue":"19/03/2018 00:00"},
{"entityName":"Evénement-Date de fin","entityValue":"24/03/2018 00:00"},
{"entityName":"Tâches-Client","entityValue":"Client 1"},
{"entityName":"Tâches-Projet","entityValue":"Projet 1"},
{"entityName":"Tâches-Phase","entityValue":"Phase 1"},
{"entityName":"Tâches-Tâche","entityValue":"Conception"},
{"entityName":"Ressources","entityValue":""}
]
]
}