Verify Anwendungsprogrammierschnittstellen (APIs)

Online bearbeiten

Verify Auf Anwendungsprogrammierschnittstellen (APIs) kann zugegriffen und diese für die interne Anwendungsentwicklung genutzt werden.

Unterstützung Weitere Informationen finden Sie in der API-Dokumentation unter IBM® Verify Dokumentationszentrum.

IBM Training Sehen Sie sich ein Verify API-Video im Rahmen der „ IBM “-Schulung an.

HTTP-Methoden

Jede API-Ressource wird durch einen benannten Uniform Resource Identifier (URI) identifiziert; der Zugriff auf die Ressource erfolgt unter Verwendung der folgenden HTTP-Standardmethoden. HTTP-Methoden geben die für ein Objekt vorgesehene Aktion an.
Tabelle 1. HTTP Methoden
HTTP-Methode Beschreibung
GET Ruft eine Ressource oder eine Beziehung an der angegebenen URL ab.
  • Eine Abfrage auf der Ebene der Ressource „ URL “ (<resource-noun>) liefert alle Instanzen unter Berücksichtigung der Such- und Paginierungsbeschränkungen (siehe Abschnitt „Suche“).
  • Eine Anfrage auf Ressourcen-ID-Ebene (<resource-noun>/<resource-id>) liefert eine einzelne Ressource zurück.
  • Eine Abfrage auf der Ebene des Beziehungsnamens (<relationship>) liefert alle Beziehungsinstanzen unter Berücksichtigung der Such- und Paginierungsbedingungen.
  • Der Standardantwortstatuscode ist 200.
  • Die Paginierung für das Ergebnis kann angepasst werden, indem ein Abfrageparameter wie beispielsweise "count" mit einem Maximalwert von 1000 hinzugefügt wird.
  • Eine Abfrage auf der Ebene der Beziehungs-ID (<relationship>/<relationship-id>) liefert eine einzelne Beziehungsinstanz zurück.
POST Erstellt eine Ressource oder Beziehung an der angegebenen URL.
  • Eine Anfrage an die Ressource URL (<resource-noun>) führt zur Erstellung der Ressource.
  • Eine Anfrage auf der Ebene der Beziehungs-ID (<relationship>) erstellt die neue Beziehung.
  • Kann für die Massenladeerstellung verwendet werden.
PUT Aktualisiert eine Ressource oder Beziehung an der angegebenen URL.
  • Eine Anfrage an die Ressource URL aktualisiert die Ressource.<resource-noun>
  • Eine Anfrage auf der Ebene der Beziehungs-ID (<relationship>) aktualisiert die neue Beziehung. Es können nicht alle Beziehungen geändert werden, das heißt, in einigen Fällen kann diese Anforderung als fehlerhafte Anforderung betrachtet werden.
  • Eine Anforderung zum Ändern schreibgeschützter Information (wie beispielsweise die Ressource oder die Beziehungs-ID) wird als fehlerhafte Anforderung betrachtet.
PATCH

Für partielle Aktualisierungen einer Ressource verwendet.

  • Eine Anfrage auf der Ebene des Ressourcentyps „ URL “<resource-noun> aktualisiert nur die Änderungen der Eigenschaften, die in der Anfrage für die angegebene Ressource angegeben sind.
  • Der Inhaltstyp für PATCH ist application/json-patch+json.
  • Wenn eine Löschoperation mit der Haupt-ID (eindeutige ID oder Eigenschaft, die einem Primärschlüssel zugeordnet ist) angegeben wird, wird das gesamte Objekt gelöscht.
DELETE Entfernt eine Ressource oder Beziehung an der angegebenen URL.
Hinweis: Verwenden Sie für das Löschen mehrerer Einträge auf einmal den Befehl PATCH.