Vous pouvez créer des identificateurs URI REST pour modifier des enregistrements
dans votre base de données utilisateur en créant directement des liens vers les enregistrements.
Pourquoi et quand exécuter cette tâche
Pour créer un identificateur URI REST afin de modifier
un enregistrement :
Procédure
- Dans la barre d'outils Rational ClearQuest Web, cliquez sur la flèche en regard de New Change Request
et sélectionnez New REST URI. L'assistant New REST URI s'ouvre.
- Sélectionnez Modifier un enregistrement dans la liste REST
URI Type.
- Sélectionnez un type d'enregistrement dans la liste Type d'enregistrement.
- Sélectionnez une action dans la liste Type d'action. Les types d'action disponibles sont déterminés par le type d'enregistrement.
- Facultatif : Sélectionnez les zones d'enregistrement à ajouter en tant que paramètres
à l'identificateur URI REST dans la liste Zones d'enregistrement à renseigner automatiquement.
- Facultatif : Pour sauvegarder tous les changements dans l'enregistrement, cochez la case Enregistrer automatiquement les changements.
- Facultatif : Pour ajouter des paramètres de connexion Rational ClearQuest Web
à votre identificateur URI REST, sélectionnez Se connecter automatiquement.
- Facultatif : Pour inclure la bannière, l'arborescence de l'espace de travail et la barre d'outils principale à la fenêtre qui s'ouvre lorsque l'identificateur URI REST s'exécute, cochez la case Inclure la bannière, l'arbre d'espace de travail et la barre d'outils principale.
- Cliquez sur Créer. Le modèle d'identificateur URI REST apparaît dans la zone REST URI Template.
- Copiez le modèle dans un éditeur de texte et remplacez par les valeurs appropriées les paramètres fictifs
qui sont entourés par deux accolades {{ }}.
Facultatif : Modifiez le format par défaut de la requête de ressources
de HTML en XML ou en ATOM.
- Copiez le modèle modifié dans votre application Web ou dans une
autre fenêtre de navigateur Web.
- Cliquez sur Réinitialiser pour créer un modèle d'identificateur URI REST
ou sur Fermer pour quitter.
Exemple
Exemples
Le modèle d'identificateur URI REST permettant
de modifier un enregistrement a été créé à l'aide de l'assistant New REST URI. Dans cet
exemple, ALMActivity a été sélectionné dans la liste Type
d'enregistrement, Activate a été sélectionné dans la liste
Type d'action et les cases Enregistrer automatiquement les changements, Se connecter automatiquement
et Inclure la bannière, l'arborescence de l'espace de travail et la barre d'outils principale ont été cochées
pour créer l'identificateur URI REST.
http://HôteServeurCQWeb/cqweb/restapi/VotreConnexion/VotreBdDUtilisateur/RECORD?format=HTML&recordType=ALMActivity&action=Activate&fieldsXml=&autoSave=true&loginId={{IDConnexion}}&password={{MotDePasse}}
Voici la correspondance des
variables et paramètres fictifs du modèle :
- HôteServeurCQWeb
- Adresse Web de votre système hôte de serveur ClearQuest Web. Cette valeur
est définie lors de la création du modèle d'identificateur URI REST.
- VotreConnexion
- Votre connexion ClearQuest. Cette valeur est définie lors de la création du
modèle d'identificateur URI REST.
- VotreBdDUtilisateur
- Votre base de données utilisateur ClearQuest. Cette valeur est définie lors de la création du
modèle d'identificateur URI REST.
- format
- Le format par défaut de la requête de ressources est HTML.
Vous pouvez changer ce format en XML ou en ATOM,
si vous le souhaitez.
- {{IDConnexion}}
- Paramètre fictif de votre ID de connexion.
- {{MotDePasse}}
- Paramètre fictif de votre mot de passe.
Les exemples suivants
vous montrent comment entrer une zone de date, une zone de référence, une liste de référence et des valeurs de zones sur plusieurs lignes en tant que paramètres dans un identificateur URI REST.
- Cet exemple montre comment indiquer une valeur de zone de date en tant que paramètre dans un identificateur URI REST afin de soumettre ou de modifier un enregistrement :
fieldsXML=<Field><Name>f_datetime</Name><Value><![CDATA[2008-09-08%2009%3A44%3A34]]></Value></Field>
Résultat :
La zone d'enregistrement f_datetime est définie sur 08/09/08
09:44:34.
- L'exemple suivant montre comment indiquer une zone de référence ou des valeurs de liste de référence en tant que paramètres dans un identificateur URI REST afin de soumettre ou de modifier un enregistrement :
fieldsXML=<Field><Name>customer</Name><Value><!CDATA[Joe%20Lee]]></Value><Value><!CDATA[Jane%20Smith]]></Value></Field><Field><Name>Project</Name><Value><!CDATA[Classics]]></Value></Field>
Résultat :
Joe
Lee et Jane Smith sont ajoutés à la liste de référence customer de l'enregistrement et Classics est ajouté à la zone de référence
Project.
- Cet exemple montre comment indiquer une valeur de zone à plusieurs lignes
en tant que paramètre dans un identificateur URI REST permettant de soumettre ou de modifier un enregistrement :
fieldsXML=<Field><Name>Description</Name><Value><![CDATA[firstline%0Asecondline]]></Value></Field>
Résultat :
Dans la zone d'enregistrement Description, les mots firstline et secondline sont formatés pour apparaître sur des lignes distinctes.