Rubrique précédente: Modèle de gestionnaireRubrique suivante: Documentation d'API détaillée


Modèle d'opérations

Les opérations qui ne s'intègrent pas au modèle de gestionnaire CRUD (Create Read Update Delete) sont gérées par le modèle d'opérations. Les opérations concernées vont de la modification de l'état d'une ressource à l'exécution d'une opération par une ressource, telle que la réinitialisation des mots de passe de démarrage.

Le modèle d'opérations est implémenté à l'aide d'une action POST au niveau d'une URL se terminant par operations/<operation name> avec une charge utile facultative. Dans l'exemple suivant, vous démarrez la grille nommée govt_sales :

POST grids/govt_sales/operations/start

Dans le langage RESTful, le modèle d'opérations crée une ressource identifiée par le nom de l'opération.

Le modèle d'opérations est souvent combiné aux modèles d'administrateur et de gestionnaire. Les opérations sur une collection gérée suivent le modèle d'administrateur. Toutefois, les opérations sur une instance gérée suivent le modèle de gestionnaire.

Le tableau de la section suivante décrit (de façon générique) la structure d'URI, l'utilisation de la méthode HTTP, la structure de charge utile et de retour pour la façon dont un client de BFC interagit avec les applications d'API.

Exemple de cible

Opérations :

BFC/admin/<resource_type>s/operations/<operation_name>, 
BFC/<resource_type>s/operations/<operation_name>, 
BFC/admin/<resource_type>/<resource_id>/operations/<operation_name>

GET

Appelle l'opération sans une charge utile. Les opérations appelées ainsi ne doivent pas créer d'effets secondaires.

Retour : résultats de l'opération.

POST

Identique à GET, mais peut engendrer des effets secondaires.

Charge utile : variable, définie par l'opération.

Retour : résultats de l'opération.