Vorgänge, die nicht in das CRUD-Managermuster fallen, werden über das Vorgangsmuster gehandhabt. Diese Vorgänge reichen von der Änderung des Status einer Ressource bis zur Durchführung eines Vorgangs durch eine Ressource, z. B. das Zurücksetzen von Kennwörtern für das Ein- und Ausschalten.
Das Vorgangsmuster wird mithilfe eines POST-Aufrufs einer URL implementiert, der auf operations/<operation name> und optional eine Nutzlast angibt. Im folgenden Beispiel starten Sie das Grid mit dem Namen "govt_sales":
POST grids/govt_sales/operations/start
Im RESTful-Sprachgebrauch erstellt das Vorgangsmuster eine neue, durch den Vorgangsnamen angegebene Ressource.
Das Vorgangsmuster kann mit dem Administrations- und Managermuster kombiniert werden, was auch häufig geschieht. Auf eine verwaltete Sammlung angewendete Vorgänge folgen dem Administrationsmuster. Auf eine verwaltete Instanz angewendete Vorgänge folgen hingegen dem Managermuster.
Die Tabelle im nächsten Abschnitt beschreibt (auf allgemeine Weise) die URI-Struktur, die Verwendung der HTTP-Methode, die Nutzlast und die Rückgabestruktur für die Interaktion eines BFC-Clients mit den API-Anwendungen.
Beispiel für ein Ziel
Vorgänge wie die Folgenden:
BFC/admin/<resource_type>s/operations/<operation_name>, BFC/<resource_type>s/operations/<operation_name>, BFC/admin/<resource_type>/<resource_id>/operations/<operation_name>
Ruft den Vorgang ohne eine Nutzlast auf. Auf diese Weise aufgerufene Vorgänge dürfen keine weiteren Auswirkungen haben.
Rückgabe: Ergebnisse des Vorgangs.
Entspricht GET, kann aber weitere Auswirkungen haben.
Nutzlast: Variabel. Wird durch den Vorgang definiert.
Rückgabe: Ergebnisse des Vorgangs.
|
Copyright © 2013 CA.
Alle Rechte vorbehalten.
|
|