Chaque type de ressource dispose d'une interface de modèle de gestionnaire. Cette interface permet de créer, de lire, de mettre à jour et de supprimer (CRUD) des instances de ce type. Le modèle de l'URL consiste à mettre au pluriel le nom du type de ressource. Par exemple, grids ou networks.
L'action POST permet de créer une instance d'un type. L'action POST se rapporte à l'URL du gestionnaire et définit une charge utile pour le type de ressource. Par exemple, pour créer une grille, appliquez l'action POST à /grids avec une charge utile comportant l'enregistrement de la grille.
L'action DELETE permet de supprimer une instance d'un type de ressource. L'URL de l'action DELETE inclut l'identificateur unique (ID, nom, etc.) du type de ressource. Par exemple, DELETE/grids/govt_sales supprime la grille nommée govt_sales.
Vous pouvez lire des instances d'un type de ressource à l'aide de GET. Cette action renvoie une liste contenant les instances.
La mise à jour d'une instance s'effectue à l'aide d'une action PUT au niveau de l'URL qui contient l'identificateur d'instance et d'une charge utile représentant les attributs modifiés et le type de ressource d'une façon similaire à celle décrite dans le modèle d'administration ci-dessus.
Vous pouvez également appliquer le modèle de gestionnaire à des attributs de liste pour un type pour lequel vous ne voulez pas spécifier la liste entière dans une mise à jour. Par exemple, au lieu d'utiliser une action PUT grids/admin avec une charge utile qui contient l'enregistrement de grille incluant la liste entière des ID de grille disponibles, utilisez le modèle de gestionnaire en émettant l'un des appels CRUD vers des paramètres de grille à l'aide de l'URL suivante :
admin/grids/availableGridIds
Vous pouvez également utiliser ce modèle d'URL pour affecter des relations d'une instance de type. Par exemple, une action POST au niveau de l'attribut servers d'un enregistrement de grille ajoutera le serveur (spécifié par la charge utile d'enregistrement du serveur) à la grille, tandis qu'une action DELETE appliquée au même niveau le supprimera.
Exemple de cible 1
BFC/<resource_type>s
Récupérez les instances gérées par ce gestionnaire.
Retour : liste des enregistrements de ressource.
Créez l'instance gérée par le gestionnaire.
Charge utile : enregistrement de ressource.
Retour : nom d'instance.
Résultat : l'instance créée est ajoutée aux ressources gérées existantes.
Exemple de cible 2
BFC/<resource_type>s/<instance id>
Récupérez l'instance identifiée par l'URL.
Retour : un enregistrement de ressource unique.
Mise à jour : mettez à jour l'instance.
Charge utile : enregistrement sporadique contenant les attributs à définir.
Retour : OK.
Résultat : la ressource est mise à jour.
Créez une connexion à la ressource ou une sous-ressource pour cette dernière.
Charge utile : enregistrement de ressource (sporadique, par exemple avec l'ID uniquement, ou avec une définition de sous-composant entièrement remplie).
Retour : identificateur d'instance.
Résultat : la ressource est connectée à l'instance de ressource ou créée pour cette dernière.
Supprimez la ressource ou annulez la relation identifiée par la ressource dans l'URL.
Charge utile : N/A
Retour : OK.
Résultat : l'instance est supprimée dans les ressources gérées existantes ou la relation de ressource.
|
Copyright © 2013 CA.
Tous droits réservés.
|
|