Vorheriges Thema: AdministrationsmusterNächstes Thema: Vorgangsmuster


Managermuster

Jeder Ressourcentyp verfügt über eine Managermusterschnittstelle. Diese Schnittstelle dient zum Erstellen, Lesen, Aktualisieren und Löschen von Instanzen dieses Typs. Das URL-Muster bewirkt, dass der Name des Ressourcentyps im Plural angegeben wird, z. B. Grids oder Netzwerke.

Führen Sie die Aktion POST aus, um eine Instanz eines Typs zu erstellen. Durch den POST-Aufruf werden die Manager-URL aufgerufen und die Nutzlast für den Ressourcentyp definiert. Um zum Beispiel ein Grid zu erstellen, führen Sie einen POST-Aufruf von /grids mit einer Nutzlast aus, die aus dem Grid-Datensatz besteht.

Führen Sie die Aktion DELETE aus, um eine Instanz eines Ressourcentyps zu löschen. Die URL für den Löschvorgang beinhaltet die eindeutige ID (ID, Name usw.) des Ressourcentyps. Beispielsweise wird durch DELETE /grids/govt_sales das Grid mit dem Namen "govt_sales" gelöscht.

Instanzen eines Ressourcentyps können mithilfe von GET gelesen werden. Diese Aktion gibt eine Liste mit den Instanzen zurück.

Zum Aktualisieren einer Instanz wird ein PUT-Aufruf der URL ausgegeben, der die Instanz-ID und eine Nutzlast für die geänderten Attribute und den Ressourcentyp enthält, ähnlich wie weiter oben für das Administrationsmuster beschrieben.

Das Managermuster kann auch auf Listenattribute innerhalb eines Typs angewandt werden, wenn Sie nicht die gesamte Liste in einer Aktualisierung angeben möchten. Sie können zum Beispiel anstelle von PUT grids/admin mit einer Nutzlast, die den Grid-Datensatz mit einer vollständigen Liste von verfügbaren Grid-IDs enthält, das Managermuster verwenden, indem Sie einen der CRUD-Anrufe für individuelle Grid-Parameter mithilfe der folgenden URL ausgeben:

admin/grids/availableGridIds

Dieses URL-Muster kann auch verwendet werden, um Beziehungen einer Typeninstanz zu beeinflussen. Zum Beispiel wird durch einen POST-Aufruf des Attributs servers in einem Grid-Datensatz der durch die Nutzlast für den Serverdatensatz angegebene Server zu dem Grid hinzugefügt, während ein vergleichbarer DELETE-Aufruf diesen löscht.

Beispiel: Ziel 1

BFC/<resource_type>s 
GET

Ruft die von diesem Manager verwalteten Instanzen ab.

Rückgabe: Eine Liste von Ressourcendatensätzen.

POST

Erstellt eine vom Manager verwaltete Instanz.

Nutzlast: Ressourcendatensatz.

Rückgabe: Instanzenname.

Ergebnis: Die erstellte Instanz wird den vorhandenen verwalteten Ressourcen hinzugefügt.

Beispiel: Ziel 2

BFC/<resource_type>s/<instance id> 
GET

Ruft die von der URL angegebene Instanz ab.

Rückgabe: Ein einzelner Ressourcendatensatz.

PUT

Aktualisierung: Aktualisiert die Instanz.

Nutzlast: Eingeschränkter Datensatz mit den festzulegenden Attributen.

Rückgabe: OK.

Ergebnis: Die Ressource wird aktualisiert.

POST

Erstellt eine Verbindung zu oder eine Unterressource für die Ressource.

Nutzlast: Ressourcendatensatz (eingeschränkt, z. B. nur mit der ID, oder vollständige Unterkomponentendefinition).

Rückgabe: Instanz-ID.

Ergebnis: Die Ressource wird mit der Ressourceninstanz verbunden oder für diese erstellt.

DELETE

Löscht die Ressource oder macht die von der Ressource in der URL angegebene Beziehung rückgängig.

Nutzlast: Keine Angaben.

Rückgabe: OK.

Ergebnis: Die Instanz wird aus den vorhandenen verwalteten Ressourcen oder der Ressourcenbeziehung entfernt.