WEBSERVICES-API-REST, Version 2: EINRICHTUNG DER API
ANFRAGEN
HTTP-Header
"apikey"
Der API-Schlüssel oder apikey wird stets im „Header“-Teil der API-Anfrage angegeben, mit Ausnahme des Zugriffspunkts „GET /attributes“, bei dem er als URL-Parameter übergeben wird.
Beispiel für eine Kopfzeilenspezifikation:
Sonderfall des Zugriffspunkts „GET /attributes“.
„Content-type“
Dieser Header definiert den Medientyp oder das „Datenformat“, das zur Festlegung des Anfragetextes bei API-POST- oder -PUT-Anfragen verwendet wird. Er muss mit dem Wert „application/json“ initialisiert werden.
Beispiel:
„autoclosesession“ (aus VP9)
Sofern dieser Header angegeben und auf „true“ gesetzt ist, wird die API-Sitzung am Ende der Anfrage beendet.
Hinweis: Wenn dieses Attribut nicht angegeben wird, lautet der Standardwert „false“.
Beispiel:
„keepalive“ (aus VP9)
Sofern dieser Header angegeben und auf „true“ gesetzt ist, gibt er an, dass die Sitzung so lange offen bleibt, bis sie explizit über den Zugriffspunkt DELETE /session oder über eine andere Anfrage, bei der der Header „autoclosesession“ auf „true“ gesetzt ist, geschlossen wird.
Hinweis: Wenn dieses Attribut nicht angegeben wird, lautet der Standardwert „false“.
Beispiel:
„rawdata“ (aus VP9)
Dieser Header dient dazu, das Format der für eine GET-Anfrage zurückgegebenen Daten festzulegen.
- Zurück zu den formatierten Werten (aktuelles und Standardformat):
Diese entsprechen den in „VPDesk“ angezeigten Werten und werden entsprechend der Ländereinstellung (Sprache) des VP-Servers formatiert.
- Wenn dieser Header nicht angegeben ist
- Wenn dieser Header angegeben, aber nicht initialisiert ist
- Wenn dieser Header angegeben und auf „false“ gesetzt ist,
- Zurück zu den Bruttowerten:
Diese entsprechen Werten, die im internen (computergestützten) Format von VP ausgedrückt werden.
- Wenn dieser Header angegeben und auf „true“ gesetzt ist
Beispiel:
„GET“-Anfragen
Vergleich der zurückgegebenen Datenformate (aus VP9 für Rohdaten)
Für Ressourcenabschnitte (Beispiele für Abschnitte)
Details
- Derzeit handelt es sich bei den formatierten Werten um diejenigen, die standardmäßig zurückgegeben werden.
- In den obigen Beispielen hängen die formatierten Werte von der Ländereinstellung ab
(Sprache) auf dem Server (EN)
- Bruttowert:
- Die Prozentwerte reichen von 0,0 (0 %) bis 1,0 (100 %).
- Werte von Datumsfeldern werden im ISO 8601-Format zurückgegeben (z. B. yyyyMM -dd
hh:mm).
- „Datum und Uhrzeit“-Werte werden im Dezimalformat zurückgegeben. Sekunden
werden in Hundertstel einer Minute angegeben. Beispiel: 75 Hundertstel einer Minute entsprechen 45 Sekunden.
- Als Dezimaltrennzeichen dient das Zeichen „.“ (dezimales Trennzeichen im Computerbereich)
Trennzeichen).
- Bruttowert:
- Das Dezimaltrennzeichen und das Tausendertrennzeichen sind
Die Angaben richten sich nach der Ländereinstellung (Sprache) des Servers.
- Die Werte von Feldern vom Typ „Datum“ werden gemäß der
Feldformat
- Werte für andere Felder werden entsprechend den festgelegten
Anzeigeformat
- Keine Unterschiede bei den Zeichenfolgen …
Zu den Attributen für Vorgänge (Beispiele für Attribute)
- Nur-Lese-Zugriff
Details
- Derzeit handelt es sich bei den formatierten Werten um diejenigen, die standardmäßig zurückgegeben werden.
- In den obigen Beispielen hängen die formatierten Werte von der Ländereinstellung ab
(Sprache) auf dem Server (FR) (z. B. Typ des Vorgangs, Lasttyp, Status usw.).
- Bruttowert:
- Prozentwerte (z. B. „Erfüllungsgrad“) reichen von 0,0 (0 %) bis 1,0 (100 %)
- Werte von Datumsfeldern werden im ISO-8601-Format zurückgegeben (z. B. JJJJ-MM-TT
hh:mm).
- Als Dezimaltrennzeichen dient das Zeichen „.“ (dezimales Trennzeichen im Computerbereich)
Trennzeichen).
- In formatierten Werten:
- Die Dezimal- und Tausendertrennzeichen werden gemäß
die Server-Ländereinstellung (Sprache).
- Die Werte von Datumsfeldern werden im Format der Ländereinstellung des Servers zurückgegeben
(Sprache)
- Kein Unterschied bei Zeichenfolgen (z. B. „Hinweis“) …
Für Bewertungsposten
- Nur-Lese-Zugriff
- Derzeit handelt es sich bei den formatierten Werten um diejenigen, die standardmäßig zurückgegeben werden.
- In den obigen Beispielen hängen die formatierten Werte von der Ländereinstellung ab
(Sprache) auf dem Server (FR)
- Bruttowert:
- Als Dezimaltrennzeichen dient das Zeichen „.“ (dezimales Trennzeichen im Computerbereich)
Trennzeichen).
- In formatierten Werten:
- Das Dezimaltrennzeichen und das Tausendertrennzeichen sind
Die Angaben richten sich nach der Ländereinstellung (Sprache) des Servers.
Für Bewertungsposten
Das Format der zurückgegebenen Daten entspricht dem der Ressourcen.
API-Zugriffspunkte zum Abrufen von Ressourcen oder Vorgängen
Verwendung eines dynamischen Filters
API-Zugriffspunkte:
- /resources/filter herunterladen
- /events/filter herunterladen
Ein „dynamischer“ Filter ist ein Ressourcenfilter oder ein Vorgangsfilter, der mindestens ein Kriterium enthält, bei dem die Option „zu beantragen“ aktiviert ist.
Beispiel:
Um diese Art von Filter in der API zu verwenden, müssen Sie für jedes Kriterium einen Variablennamen eingeben und dabei die Option „abzufragen“ aktivieren. Klicken Sie dazu auf den Bleistift rechts neben dem Kontrollkästchen, um das Popup-Fenster zur Eingabe des Variablennamens anzuzeigen.
Beispiel: Geben Sie für das Kriterium „Projekt“ den Variablennamen PROJECT ein.
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:
Dieser Filtertyp kann auch im APIDesigner verwendet werden, wenn eine GET-Anfrage zum Abrufen von Ressourcen oder Vorgängen erstellt wird.
Der Abschnitt „RequestREST“ enthält einen Unterabschnitt „Parameter“, in dem die Variablennamen beschrieben werden, die für alle Kriterien definiert sind, bei denen die Option „request“ aktiviert ist.
