In der API-Anfrage werden diese Parameter als URL-Parameter unter Verwendung der Notation „=“ definiert (z. B. PROJECT=Projekt 0).
Wenn wir ein API-Testtool wie POSTMAN verwenden, sieht die Anfrage wie folgt aus:
Verwendung von Operatoren
Die Verwendung von Operatoren ermöglicht das gefilterte Anzeigen von Ressourcen oder Vorgängen, ohne dass Filter oder in den Planungen definierte Exportkontexte verwendet werden müssen. Auf der Ebene der API-Anfragen werden diese Parameter als URL-Parameter definiert und müssen die folgenden Notationen beachten:
- operator= (Beispiel: operator=GREATER)
- = (Beispiel: Startdatum des Vorgangs = 12.09.2020) Details:
- Es können verschiedene Operatoren verwendet werden
- Für einen einzelnen Bediener können mehrere Kriterien definiert werden
Die Kriterien, die ein Operator anwendet, müssen unmittelbar auf die Deklaration des Operators folgen.
- Die Standardverknüpfung zwischen den verschiedenen Operatoren ist „UND“ (es ist jedoch möglich, „ODER“ zu wählen).
Bedingung) (nur ab VP8 verfügbar – siehe API-Dokumentation).
Beispiel: Wiedergabe eines Vorgangs mit den folgenden Kriterien:
- Das Startdatum des Vorgangs liegt nach dem.
- Das Enddatum des Vorgangs liegt vor dem.
- Eine Ressource in der Dimension „Aufgaben“ wird anhand ihrer UID identifiziert.
- Die Auslastung in Tagen beträgt 2
Wenn wir ein API-Testtool wie POSTMAN verwenden, sieht die Anfrage wie folgt aus: {{LOCALHOST}}/api/{API_VERSION}}/events?operator=GREATER&Event-Start date=09/12/2020&operator=LESSER&Event-End date=18/12/2020&operator=EQUALS&Tasks=RES_TACHE_PRJ0_PHA0_ANALYSE&Event-Load in days=2
Die verfügbaren Operatoren sind: EQUALS, GREATER, LESSER, GREATEREQUALS, LESSEREQUALS, NOTEQUALS, LIKE, STARTWITHS, ENDWITHS,
INHALT, NICHT IM INHALT, NICHT AM ANFANG, NICHT AM ENDE.
Auswahl der Attribute in den Abfrageergebnissen: Parameter „attribute“
Standardmäßig werden alle Ressourcenfelder bzw. Attribute für Vorgänge zurückgegeben, sofern kein „attribute“-Parameter angegeben wird.
Der Parameter „attribute“ kann für die folgenden Abfragen verwendet werden:
- Vorgänge mit oder ohne Operatoren abrufen (GET /events)
- Vorgänge mit Filter abrufen (GET /events/filter)
- Einen Vorgang lesen (GET /events/{UID})
- Ressourcen mit oder ohne Operatoren abrufen (GET /resources)
- Ressourcen mit Filter abrufen (GET /resources/filter)
- Eine Ressource abrufen (GET /resources /{UID})
Verwenden Sie den Parameter „attribute“, um die zurückzugebenden Attribute oder Felder auszuwählen.
Der Parameter „attribute“ wird so oft angegeben, wie spezifische Attribute zurückgegeben werden sollen.
Auf der Ebene der API-Anfragen werden diese „Attribut“-Parameter als URL-Parameter definiert
Beispiel: Abrufen von Ressourcen aus der Dimension „Aufgaben“ unter Verwendung von Operatoren und Attributangaben, die zurückgegeben werden sollen
{{LOCALHOST}}/api/{API_VERSION}}/resources ?resourceModel=Tasks&operator=EQUALS&Ta sks-Project=Project 0&Tasks-Phase=Phase 0&operator=NOTEQUALS&Tasks-Task=Delivery&attribute=Tasks-Internal Identifier (UID)&attribute=Tasks-Project&attribute=Tasks-Phase&attribute=TasksTask
Abfrageergebnis (Beispiel für die erste der vier zurückgegebenen Ressourcen):
Beispiel: Abrufen von Vorgängen mit Operatoren und Festlegen der zurückzugebenden Attribute
{{LOCALHOST}}/api/{API_VERSION}}/events ?operator=GREATER&Event-Start date=09/12/2020&operator=LESSER&Event-End date=18/12/2020&operator=EQUALS&Tasks=RES_TACHE_PRJ0_PHA0_ANALYSE&Event-Load in days=2&attribute=Event-Start date&attribute=Event-End date&attribute=Event-Load in days&attribute=Tasks-Internal identifier (UID)
Rückgabeanfrage
Ressourcenattribute lesen
Zum Nachlesen von Ressourcen
Per Definition ist der Rückgabewert eines Feldes vom Typ „Ressource“ sUID die Ressource.
Beispiel für ein Attribut (z. B. „Aufgaben – Kunde“), dessen Feld („Kunde“) ein Feld vom Typ „Ressourcentyp“ ist.
Der Rückgabewert des Attributs „Customer-Tasks“ ist die UID der Ressource „Customer“.
Zum Lesen von Vorgängen
Per Definition ist der Rückgabewert einer in einem Vorgang referenzierten Ressource die UID der referenzierten Ressource.
Beispiel für ein Attribut (z. B. „Aufgaben“), das einer Ressource zugeordnet ist.
Der zurückgegebene Wert ist die UID der Ressource „Aufgaben“.
Beispiel für ein Attribut (z. B. „Aufgaben – Kunde“), dessen Feld („Kunde“) ein Feld vom Typ „Ressourcentyp“ ist.
Der zurückgegebene Wert ist die UID des Feldes der Ressource „Kunde“.
Auslesen eines bestimmten Elements in einem Element vom Typ „Ressource“.
Wenn Sie den Wert eines bestimmten Feldes (z. B. „Adresse“) aus einem Feld vom Typ „Ressource“ (z. B. „Kunden-Aufgaben“) abrufen möchten, verwenden Sie bitte die folgende Attributbezeichnung: „Attribut(Feld)“ (z. B. „TasksCustomer(Adresse)“).
Diese Notation findet beim Auslesen von Vorgängen oder Ressourcen Anwendung.
APIDesigner und GET-Anfrage (wird ab VP9 offiziell eingeführt)
Jedes Mal, wenn Sie eine GET-Methode zum globalen Abruf von Ressourcen oder Vorgängen (mit oder ohne Filterauswahl) erstellen, wird automatisch eine GET-Methode zum gezielten Abruf einer bestimmten Ressource oder eines bestimmten Vorgangs erstellt.
Beispiel: Globale Lesemethode für Dimensionsressourcen (z. B. „Kunden“)
Die URL der spezifischen Methode zum Abrufen einer Ressource in der Dimension „Kunden“ lautet:
- http://localhost:8908/ip50/api/4/getclients/{uid}
Dabei steht {uid} für die UID der Ressource, die gelesen werden soll
Beispiel: Methode zum Abrufen globaler Vorgänge
Die URL der spezifischen Methode zum Abrufen eines Vorgangs lautet:
- http://localhost:8908/ip50/api/4/getevents/{uid}
wobei {uid} die UID des zu lesenden Vorgangs bezeichnet.
„PUT“- UND „POST“-ANFRAGEN
Datenformat des Request-Bodys (aus VP9 für formatierte Werte)
Daten, die zum Anlegen oder Bearbeiten einer Ressource oder eines Vorgangs verwendet werden, müssen im Format JSON strukturiert sein (strukturierte Daten auf Basis von Listen [Wert_1, …, Wert_n] und Wörterbüchern {Schlüssel_1:Wert_1, …, Schlüssel_n:Wert_n}).
Derzeit werden die Werte im „Rohformat“ angegeben.
Ab VP9 kann der für ein Attribut oder Feld angegebene Wert entweder ein formatierter Wert oder ein „Rohwert“ sein (siehe § 2.2.1 Vergleich der zurückgegebenen Datenformate).
Beispiel für Felder für Ressourcen in formatierten Werten:
Beispiel für Rubriken für Ressourcen in „Brutto“-Werten:
Beispiel für Attribute von Vorgängen in formatierten Werten:
