Les types de l'API de BFC peuvent disposer d'une interface d'administration facultative pour définir des données de configuration. Le modèle d'URL est admin/<resource_type>s (par exemple, admin/grids).
Ce modèle d'URL est utilisé lorsque la configuration s'applique à toutes les instances du type spécifié. Vous pouvez également appliquer le modèle d'administration à une instance de ressource lorsqu'une configuration plus affinée est recommandée, par exemple, une grille spécifique. La portée est effectuée en ajoutant l'ID de la ressource visée à l'URL :
admin/<resource_type>/<resource_id>
Par exemple :
admin/grids/mygrid
Vous pouvez utiliser une action GET pour renvoyer un enregistrement lorsque l'ensemble de données de configuration est corrigé.
Lorsqu'une cible admin dispose de nombreuses valeurs de configuration, une liste dynamique de valeurs de configuration est prise en charge via la chaîne de requête. Cela permet au client de bénéficier d'un haut degré de flexibilité lorsqu'il doit décider des portions de données à extraire du serveur. Exemple d'URL :
admin/grids?keys=backboneid,licensekey
Pour définir des valeurs de configuration, utilisez une action PUT.
En outre, les interfaces d'administration autorisent la définition de valeurs de configuration spécifiques en utilisant une action PUT au niveau de l'URL avec la clé incluse (par exemple, admin/grids/backboneControllerId ou /admin/discovery) et une charge utile pour les valeurs mises à jour.
Pour effacer une valeur de configuration, utilisez une action PUT et la valeur null dans l'enregistrement correspondant. Facultativement, vous pouvez utiliser une action DELETE avec la clé dans l'URL (par exemple, admin/grids/licensekey ou admin/backboneId).
Exemple de cible 1
BFC/admin/<resource_type>s, BFC/admin/<resource_type>/<resource_id>
Récupérez la configuration pertinente par rapport au type de ressource ou à la ressource.
Retour : enregistrement de configuration.
Remplacez la configuration.
Charge utile : enregistrement sporadique contenant les champs à définir.
Retour : OK.
Résultat : les valeurs dans l'enregistrement sporadique sont mises à jour.
Exemple de cible 2
BFC/admin/<resource_type>s/<parameter>, BFC/admin/<resource_type>/<resource_id>/<parameter>
Récupérez la valeur de configuration pour le paramètre nommé.
Chaîne de requête : N/D.
Retour : valeur de configuration.
Remplacez la valeur de configuration.
Charge utile : nouvelle valeur de configuration.
Retour : OK.
Résultat : la valeur du paramètre de configuration spécifié est mise à jour.
Supprimer : valeur du paramètre de configuration spécifié.
Charge utile : N/A
Retour : OK.
Résultat : la valeur du paramètre de configuration spécifié est annulée.
|
Copyright © 2013 CA.
Tous droits réservés.
|
|