Méthodes REST HTTP

L'API REST prend en charge les méthodes HTTP suivantes pour la manipulation de ressources :

POST (CREATE) crée une ressource.

GET (READ) renvoie la représentation d'une ressource.

PUT (UPDATE) met à jour une ressource existante.

DELETE supprime la ressource.

Cet ensemble de méthodes est également connu sous le nom de CRUD. Chaque méthode fonctionne de la même manière sur toutes les ressources CA SDM. Vous avez uniquement besoin d'une bibliothèque de client HTTP, disponible dans la plupart des langages de programmation. Utilisez la bibliothèque client HTML pour effectuer les tâches suivantes :

Accéder aux ressources associées (ou liées) à l'aide d'un chemin d'accès URI multiniveau et les modifier.

Envoyer une requête HTTP au serveur pour la ressource à manipuler.

Contrôler les attributs d'objet à renvoyer à l'aide des en-têtes HTTP.

Après la mise à jour des définitions d'objet Majic et le redémarrage de CA SDM, le produit régénère et redéploie automatiquement les objets Java simples (POJO) correspondants dans le répertoire webapps Tomcat REST.

Remarque : L'utilitaire de ligne de commande pdm_rest_util vous permet de générer, de compiler et de déployer manuellement le code Java requis par les services Web REST.

Important : Les demandes pour les attributs qui ne répondent pas spécifient une valeur d'attribut nulle. Modifiez votre code client en conséquence, car REST n'affiche pas de valeurs d'attribut nulles dans les réponses.

Les services Web REST vous fournissent une configuration adaptable et une meilleure flexibilité en vous permettant de vous connecter à un serveur domsrvr dédié sur le serveur local. Par défaut, CA SDM r12.9 fournit la variable NX_REST_WEBSERVICE_DOMSRVR au serveur domsrvr. Vous pouvez modifier le fichier NX.env pour changer cette configuration.

CA SDM désactive l'exemple d'interface utilisateur mobile REST et expose tous les sous-objets Majic à l'aide des services Web REST par défaut.

Important : L'API REST ne prend pas en charge les attributs Majic de type DOUBLE.

La table suivante présente l'utilisation des méthodes HTTP sur des ressources par l'API REST.

Ressource	CREATE	READ	UPDATE	DELETE
URL de la collection Par exemple : http://mywebsite.com/resources/	Crée une entrée dans la collection. Affecte une nouvelle URL d'entrée automatiquement et la renvoie par l'opération.	Répertorie les URL et d'autres détails sur les membres de la collection.	N/D	N/D
URL de l'élément Par exemple : http://mywebsite.com/resources/item1	N/D	Récupère une représentation du membre de la collection sollicité.	Met à jour le membre de la collection sollicité ou le crée s'il n'existe pas.	Supprime le membre de la collection sollicité.

Ressource

CREATE

READ

UPDATE

DELETE

URL de la collection

Par exemple : http://mywebsite.com/resources/

Crée une entrée dans la collection. Affecte une nouvelle URL d'entrée automatiquement et la renvoie par l'opération.

Répertorie les URL et d'autres détails sur les membres de la collection.

N/D

URL de l'élément

Par exemple : http://mywebsite.com/resources/item1

N/D

Récupère une représentation du membre de la collection sollicité.

Met à jour le membre de la collection sollicité ou le crée s'il n'existe pas.

Supprime le membre de la collection sollicité.