Typen innerhalb der BFC-API können optional eine Administrationsschnittstelle zum Einstellen der Konfigurationsdaten aufweisen. Das URL-Muster ist admin/<resource_type> (z. B. admin/grids).
Dieses URL-Muster wird verwendet, wenn die Konfiguration für alle Instanzen des angegebenen Typs gilt. Das Administrationsmuster kann auch auf eine Ressourceninstanz angewendet werden, wenn eine präzisere Konfiguration erforderlich ist, z. B. ein spezifisches Grid. Die Bereichsdefinition erfolgt, indem der URL die ID der gewünschten Ressource hinzugefügt wird:
admin/<resource_type>/<resource_id>
Zum Beispiel:
admin/grids/mygrid
Mithilfe eines GET-Aufrufs können Sie einen Datensatz zurückgeben, wenn der Konfigurationsdatensatz festgelegt ist.
Wenn ein Verwaltungsziel mehrere Konfigurationswerte hat, wird eine dynamische Liste der Konfigurationswerte über die Abfragezeichenfolge unterstützt. Dies gibt dem Client maximale Flexibilität bei der Entscheidung, welche Teildaten vom Server abgerufen werden. Hier ein Beispiel für eine URL:
admin/grids?keys=backboneid,licensekey
Um Konfigurationswerte festzulegen, verwenden Sie einen PUT-Aufruf.
Zusätzlich erlauben Administrationsschnittstellen die Einstellung konkreter Konfigurationswerte mithilfe eines PUT-Aufrufs der URL mit eingeschlossenem Schlüssel (z. B. admin/grids/backboneControllerId oder /admin/siscovery) und einer Nutzlast für die aktualisierten Werte.
Um einen Konfigurationswert zu löschen, verwenden Sie einen PUT-Aufruf und den Wert null im entsprechenden Datensatz. Optional können Sie einen DELETE-Aufruf mit dem Schlüssel in der URL verwenden (z. B. admin/grids/licensekey oder admin/backboneId).
Beispiel: Ziel 1
BFC/admin/<resource_type>s, BFC/admin/<resource_type>/<resource_id>
Ruft die Konfiguration für "resource_type" oder die Ressource ab.
Rückgabe: Konfigurationsdatensatz.
Ersetzt die Konfiguration.
Nutzlast: Eingeschränkter Datensatz mit den festzulegenden Feldern.
Rückgabe: OK.
Ergebnis: Werte im eingeschränkten Datensatz werden aktualisiert.
Beispiel: Ziel 2
BFC/admin/<resource_type>s/<parameter>, BFC/admin/<resource_type>/<resource_id>/<parameter>
Ruft den Konfigurationswert für den genannten Parameter ab.
Abfragezeichenfolge: Keine Angaben.
Rückgabe: Konfigurationswert.
Ersetzt den Konfigurationswert.
Nutzlast: Neuer Konfigurationswert.
Rückgabe: OK.
Ergebnis: Der Wert für den angegebenen Konfigurationsparameter wird aktualisiert.
Löschen: Der Wert für den angegebenen Konfigurationsparameter.
Nutzlast: Keine Angaben.
Rückgabe: OK.
Ergebnis: Der Wert für den angegebenen Konfigurationsparameter wird zurückgesetzt.
|
Copyright © 2013 CA.
Alle Rechte vorbehalten.
|
|