--- sourceDocument: Workflows de version Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/build-workflows Release : - xanadu ft:locale : - fr-FR ft:publication_title : - Workflows de version Xanadu ft:clusterId : - crworkflow bundleId : - crworkflow workflow : - Creator --- # Étape REST # Étape REST {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 14 minutes de lecture Envoyez une demande de service Web REST sortante à un système externe. Remarque : Étape REST n'est pas disponible dans le système de base et nécessite un ServiceNow® Hub d'intégration abonnement. Une fois le module d'extension requis activé, l'étape est visible sous Intégrations. Le service Web REST sortant est une fonctionnalité de plateforme qui vous permet de récupérer, créer, mettre à jour ou supprimer des données sur un serveur de services Web qui prend en charge l'architecture REST. ## Rôles et disponibilité {#rest-request-action-designer__section_pwq_rb5_kcb} Disponible en tant qu'étape d'action Studio de workflow . Les utilisateurs disposant du rôle action_designer peuvent créer une action personnalisée avec une ou plusieurs étapes d'action. ## Champs {#rest-request-action-designer__section_cbz_tj5_kcb} {#rest-request-action-designer__table_p4n_cht_3cb__entry__2}{#rest-request-action-designer__xml-stream} | Champ | Description | |-|-| | Connexion | Type de connexion à utiliser. * Définir l'inline de la connexion : Définissez les informations de connexion dans l'étape d'action. * Utiliser l'alias de connexion : Définissez les informations de connexion à l'aide de la table Alias de connexion. L'utilisation d'un alias élimine la nécessité de configurer plusieurs informations d'identification et profils d'informations de connexion lors de l'utilisation d'une action dans plusieurs environnements. De même, si les informations de connexion changent, vous n'avez pas besoin de mettre à jour votre action personnalisée. {#rest-request-action-designer__ul_mk2_cxz_kbb} Pour en savoir plus sur les connexions et les informations [d'identification, consultez Présentation des informations d'identification, des connexions et des alias](https://www.servicenow.com/docs/access?context=credentials-connections-alias&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). | | Alias de connexion | Enregistrement d'alias de connexion et d'informations d'identification que le système utilise pour exécuter l'étape d'action. Les utilisateurs disposant du rôle flow_designer ou admin peuvent créer ou sélectionner un enregistrement de connexion associé. L'utilisation d'un alias élimine la nécessité de configurer plusieurs informations d'identification et profils d'informations de connexion lors de l'utilisation d'une action dans plusieurs environnements. De même, si les informations de connexion changent, vous n'avez pas besoin de mettre à jour votre action personnalisée. Pour en savoir plus sur les connexions et les informations d'identification [, consultez Informations d'identification, connexions et alias](https://www.servicenow.com/docs/access?context=credentials-connections-alias&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). La valeur d'informations d'identification s'affiche sous la forme d'une pastille de données de mot de passe (2 sens cryptés) sur le panneau de données. Remarque : Ce champ est disponible lorsque l'option Utiliser l'alias de connexion est sélectionnée dans la liste Connexion. | | Alias d'informations d'identification | Alias d'informations d'identification utilisé par le système pour exécuter l'étape d'action. Les utilisateurs disposant du rôle flow_designer ou admin peuvent créer ou sélectionner un enregistrement de connexion associé. L'utilisation d'un alias élimine la nécessité de configurer plusieurs informations d'identification lors de l'utilisation d'une action dans plusieurs environnements. De même, si les informations d'identification changent, vous n'avez pas besoin de mettre à jour votre action personnalisée. Pour en savoir plus sur les connexions et les informations d'identification [, consultez Informations d'identification, connexions et alias](https://www.servicenow.com/docs/access?context=credentials-connections-alias&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). La valeur d'informations d'identification s'affiche sous la forme d'une pastille de données de mot de passe (2 sens cryptés) sur le panneau de données. Remarque : Ce champ est disponible lorsque l'option Définir l'inline de la connexion est sélectionnée dans la liste Connexion. | | Utiliser MID | Option permettant d'utiliser un ServiceNow® Serveur MID pour exécuter le Étape RESTfichier . Cochez cette case pour afficher les champs Application MID et Options . Remarque : Le système ne consigne pas les données d'exécution de la demande, de la réponse et des paramètres REST envoyées via un MID Server de la même manière que la journalisation des services Web sortants . Au lieu de cela, vous pouvez afficher ces données dans les [détails d'exécution du flux](https://servicenow-prod.fluidtopics.net/_4mO8shwim0Z6VstukiH3Q "Affichez les informations d’exécution sur une action ou un flux directement à partir de l’environnement de conception, telles que l’état actuel, les éléments exécutés et les valeurs produites. Ouvrez les enregistrements connexes à partir d’éditeurs incorporés Now Platform ou dans un nouvel onglet."). | | URL de base | URL de base de la demande REST. * Si l'option Utiliser l'alias de connexion est sélectionnée, ce champ affiche l'URL de base associée à l'alias. Vous pouvez remplacer l'URL de base en cliquant sur l'icône de verrouillage ( ![icône de verrouillage]()) et en saisissant la vôtre. * Si Définir l'inline de la connexion est sélectionné, entrez une URL de base pour la connexion. {#rest-request-action-designer__ul_rrb_1zg_htb} | | Tester l'étape REST | Bouton permettant de tester l'étape REST. Pour tester, sélectionnez le bouton Tester l'étape REST . Entrez les valeurs d'entrée requises et sélectionnez le bouton Exécuter le test . Une fois le test exécuté, les sorties d'étape ou les messages d'erreur s'affichent dans la section Résultats des tests de la fenêtre de test. | | Délai de connexion | Nombre de millisecondes pendant lesquelles le système attend une connexion de l'hôte réussie. Si l'étape n'aboutit pas à une connexion pendant ce temps, la demande de connexion expire. Si Définir l'inline de la connexion est sélectionné, entrez une valeur de délai d'expiration pour la connexion. Laissez ce champ vide pour utiliser la valeur de délai de connexion par défaut du système. | | Sélection de MID | Option permettant de sélectionner le serveur MID ou la grappe MID spécifique. * Sélectionner automatiquement un serveur MID : sélectionne automatiquement le serveur MID. * Serveur MID spécifique : utilise le serveur MID que vous sélectionnez. * Grappe MID spécifique : utilise la grappe MID que vous sélectionnez. {#rest-request-action-designer__ul_zdy_2cb_htb} Ce champ est disponible lorsque l'option Définir l'inline de la connexion est sélectionnée dans la liste Connexion et que l'option Utiliser MID est cochée. | | Application MID | Capacités que le doit prendre en charge pour être éligible à la Serveur MID sélection. Le système exécute l'étape d'action à partir d'un Serveur MID qui prend en charge les options sélectionnées. Ce champ est disponible lorsque l'option Définir l'inline de la connexion est sélectionnée dans la liste Connexion, que la case Utiliser MID est cochée et que l'option Sélectionner automatiquement Serveur MID est sélectionnée dans la liste Sélection MID. | | Aptitudes | Capacités que le doit prendre en charge pour être éligible à la Serveur MID sélection. Le système exécute l'étape d'action à partir d'un Serveur MID qui prend en charge les options sélectionnées. Ce champ est disponible lorsque l'option Définir l'inline de la connexion est sélectionnée dans la liste Connexion, que la case Utiliser MID est cochée et que l'option Sélectionner automatiquement Serveur MID est sélectionnée dans la liste Sélection MID. | | Serveur MID | Pilule de données de l'espace requis Serveur MID. Ce champ est disponible lorsque l'option Définir l'inline de la connexion est sélectionnée dans la liste Connexion, que la case Utiliser MID est cochée et que Serveur MID spécifique est sélectionné dans la liste Sélection MID. | | Grappe MID | Pilule de données pour la grappe MID que vous souhaitez utiliser. Ce champ est disponible lorsque l'option Définir l'inline de la connexion est sélectionnée dans la liste Connexion, que l'option Utiliser MID est cochée et que l'option Grappe MID spécifique est sélectionnée dans la liste Sélection MID. | | Demande de version | Option permettant de créer la demande manuellement, d'importer une spécification OpenAPI ou d'importer un message REST. * Manuellement : créez des entrées d'action et remplissez manuellement le formulaire Étape REST. * À partir de la spécification OpenAPI : importez une spécification OpenAPI pour générer des entrées d'action et remplissez le formulaire Étape REST. Pour plus d'informations, consultez [Prise en charge d'OpenAPI à l'étape REST](https://www.servicenow.com/docs/access?context=open-api-integration&version=xanadu&pubname=xanadu-integrate-applications&ft:locale=en-US). * À partir du message REST : importez un message REST de plateforme. Pour plus d'informations, consultez [Importer un message REST dans une étape REST](https://www.servicenow.com/docs/access?context=import-rest-message-step&version=xanadu&pubname=xanadu-integrate-applications&ft:locale=en-US). {#rest-request-action-designer__ul_kxt_z3x_xgb} | | Source de l'API | Option permettant de sélectionner une spécification OpenAPI utilisée pour construire la demande, ou de sélectionner Importer OpenAPI pour importer une nouvelle spécification OpenAPI. Vous pouvez importer des spécifications en fournissant une URL vers le YAML ou le JSON, ou en copiant et collant du contenu. Remarque : Ce champ est disponible lorsque vous sélectionnez À partir de la spécification OpenAPI dans la liste Demande de version. | | Opération API | Option permettant de sélectionner une opération dans la liste. Les opérations disponibles sont fournies par la spécification OpenAPI dans le champ Source de l'API . Remarque : Ce champ est disponible lorsque vous sélectionnez À partir de la spécification OpenAPI dans la liste Demande de version. | | Message REST | Nom du message REST à importer. Sélectionnez un message REST dans la liste. Remarque : Ce champ est disponible lorsque vous sélectionnez À partir du message REST dans la liste Demande de version. | | Fonction de message REST | Nom de la fonction à partir de laquelle importer le message REST. Les options disponibles sont déterminées par les méthodes HTTP associées au message REST sélectionné. Remarque : Ce champ est disponible lorsque vous sélectionnez À partir du message REST dans la liste Demande de version. | | Importer le message REST | Bouton permettant d'importer le message REST. Remarque : Ce champ est disponible lorsque vous sélectionnez un message REST dans le champ Message REST . | | Chemin d'accès à la ressource | Chemin d'accès de la ressource. | | Fonction de message REST | Méthode HTTP utilisée pour traiter la demande. * GET * POST * PUT * CORRECTIF * DELETE {#rest-request-action-designer__ul_ivc_211_lbb} | | Paramètres de requêtes | Paires nom-valeur à transmettre au point de terminaison REST. Vous pouvez créer ces paramètres manuellement ou faire glisser les variables d'entrée dans les champs de paramètres, puis affecter une valeur. Prenez en charge les demandes d'étape REST qui contiennent des noms de paramètres de requête en double. Si vous créez une demande REST contenant des noms de paramètres de requête en double, Studio de workflow ajoute les paramètres de requête à la demande dans le même ordre que vous les avez définis. Remarque : lors de l'importation d'une spécification OpenAPI, le système ajoute tous les paramètres et en-têtes présents dans la spécification à l'étape REST. Passez en revue les valeurs de l'étape REST finale et supprimez les paramètres que vous ne souhaitez pas envoyer dans la demande. Par exemple, si l'API accepte les en-têtes de type de contenu pour les formats JSON et XML, le système ajoute les deux en-têtes à l'étape REST. Supprimez l'un des en-têtes en fonction du type de contenu que vous souhaitez recevoir dans la réponse. | | En-têtes | En-têtes à envoyer avec la demande. Vous pouvez créer des en-têtes manuellement ou faire glisser des variables d'entrée dans les champs de paramètres, puis affecter une valeur. Prendre en charge les demandes d'étape REST qui contiennent des en-têtes de demande en double. Si vous créez une demande REST contenant des en-têtes de demande en double, les en-têtes sont envoyés dans le même ordre que vous les avez définis. Remarque : lors de l'importation d'une spécification OpenAPI, le système ajoute tous les paramètres et en-têtes présents dans la spécification à l'étape REST. Passez en revue les valeurs de l'étape REST finale et supprimez les paramètres que vous ne souhaitez pas envoyer dans la demande. Par exemple, si l'API accepte les en-têtes de type de contenu pour les formats JSON et XML, le système ajoute les deux en-têtes à l'étape REST. Supprimez l'un des en-têtes en fonction du type de contenu que vous souhaitez recevoir dans la réponse. | | Type de demande | Format de la demande. Les options comprennent. * Texte : demande au format JSON ou XML ou dans un autre format texte.{#rest-request-action-designer__text} {#rest-request-action-designer__text} * Binaire : demande effectuée dans un format de fichier binaire.{#rest-request-action-designer__binary} {#rest-request-action-designer__binary} * Plusieurs parties : demande composée de plusieurs types de contenu. * Codage URL de formulaire : demande dans une requête codée URL. {#rest-request-action-designer__ul_acb_ppv_ldb} Remarque : Ce champ est modifiable lorsque la méthode HTTP est POST,PUT, PATCH ou DELETE. | | Corps de la demande \[texte\] | Corps de la demande au format JSON ou XML. Les détails d'exécution du flux affichent le corps de la réponse sous la forme d'un lien vers la visionneuse de texte incorporé ou de sys_id de l'enregistrement de pièce jointe contenant la réponse. Remarque : Ce champ est modifiable si vous sélectionnez Texte dans la liste Type de demande. | | Pièce jointe | Enregistrement de la pièce jointe qui contient la demande. Vous pouvez rechercher ou créer cet enregistrement dans une étape antérieure et le définir comme variable d'entrée. Créez-le à l'aide des API JSONStreamingBuilder et XMLStreamingBuilder dans l'étape Script. Remarque : Ce champ est disponible lorsque vous sélectionnez Binaire dans la liste Type de demande. | | Nom, type de pièce, valeur | Contenu d'une demande en plusieurs parties. Pour chaque article, spécifiez son nom, son type de pièce et sa valeur soit à l'aide des champs individuellement, soit à l'aide d'un script en ligne pour toutes les pièces. Vous pouvez spécifier les valeurs en plusieurs parties en cliquant sur l'icône Activer/désactiver les scripts (icône ![Activer/désactiver les scripts en ligne]()) et en modifiant le script. Pour plus d'informations sur le scripting en ligne, reportez-vous à [Scripts alignés](https://servicenow-prod.fluidtopics.net/yspe03vPNnsFZu3q97dWyQ "Permettez aux utilisateurs ayant de l’expérience en codage d’écrire des scripts en ligne qui définissent et modifient les valeurs d’entrée pendant la configuration d’une action ou d’un flux. Utilisez les scripts en ligne pour modifier les valeurs d’entrée qui nécessitent des conversions de petits formats, des transformations de données ou des opérations mathématiques."). * Nom :nom de la pièce. Il peut s'agir de n'importe quelle chaîne valide. * Type de pièce : type de la pièce. Sélectionnez Texte ou Fichier. * Texte :le texte de la pièce. Une fois le texte sélectionné, vous pouvez spécifier le type de contenu. * Fichier : le fichier de la pièce. Lorsque Fichier est sélectionné, la valeur doit être la sys_id de l'enregistrement de pièce jointe contenant le contenu. Vous pouvez rechercher cet enregistrement dans une étape antérieure ou le définir comme valeur d'entrée. Une fois le fichier sélectionné, vous pouvez spécifier le nom du fichier et le type de contenu. * Pour Set Filename (Définir le nom de fichier), sélectionnez À partir de la pièce jointe pour utiliser le nom de fichier de l'enregistrement joint ou sélectionnez À partir de l'entrée Nom de fichier pour entrer le vôtre. * Pour Set Content Type (Définir le type de contenu), sélectionnez À partir de la pièce jointe pour utiliser le type de contenu de l'enregistrement joint ou sélectionnez À partir de l'entrée Type de contenu pour saisir le vôtre. {#rest-request-action-designer__ul_zgm_l4m_gtb} {#rest-request-action-designer__ul_o4p_4nm_gtb} * Valeur : contenu de l'article. Pour le texte, la valeur est le contenu du texte. Pour un fichier, la valeur est la sys_id de l'enregistrement de pièce jointe contenant le contenu. {#rest-request-action-designer__ul_ttq_wzj_f2b} Remarque : Ces champs sont disponibles lorsque vous sélectionnez Plusieurs parties dans la liste Type de demande. | | Nom, valeur | Contenu d'une demande codée par l'URL d'un formulaire. Spécifiez chaque partie de la demande codée URL avec une paire nom-valeur à l'aide des champs individuellement ou à l'aide d'un script en ligne pour toutes les parties. Vous pouvez spécifier le script inline des valeurs codées par l'URL du formulaire en cliquant sur l'icône Activer/désactiver le script (icône ![Activer/désactiver le script en ligne]()) et en modifiant le script. Pour plus d'informations sur le scripting en ligne, reportez-vous à [Scripts alignés](https://servicenow-prod.fluidtopics.net/yspe03vPNnsFZu3q97dWyQ "Permettez aux utilisateurs ayant de l’expérience en codage d’écrire des scripts en ligne qui définissent et modifient les valeurs d’entrée pendant la configuration d’une action ou d’un flux. Utilisez les scripts en ligne pour modifier les valeurs d’entrée qui nécessitent des conversions de petits formats, des transformations de données ou des opérations mathématiques."). Remarque : Ce champ est disponible lorsque vous sélectionnez Codage URL de formulaire dans la liste Type de demande. | | Activer la politique des nouveaux essais | Option permettant d'activer la politique des nouveaux essais. Pour plus d'informations, reportez-vous à [Politique des nouveaux essais](https://servicenow-prod.fluidtopics.net/xkG_Br2NTNIIFj_bEV1NCA#retry-policy "Relancez automatiquement les demandes ayant échoué lorsqu’une étape rencontre un problème intermittent tel qu’une défaillance réseau ou une limite de taux de demande. Définissez une politique des nouveaux essais pour éviter d’avoir à déclencher à nouveau manuellement l’étape."). | | Remplacer la politique des nouveaux essais pour l'alias | Option permettant de remplacer la politique des nouveaux essais par défaut. Cette case à cocher n'est pas disponible si l'option Définir l'inline de la connexion est sélectionnée dans la liste des connexions. | | Politique des nouveaux essais | Politique des nouveaux essais par défaut associée à l'alias de connexion. Si l'option Remplacer la politique des nouveaux essais pour l'alias est sélectionnée, vous pouvez remplacer la politique des nouveaux essais par défaut et sélectionner une autre politique existante des nouveaux essais en fonction de vos besoins. | | Enregistrer en tant que pièce jointe | Option permettant de spécifier s'il faut enregistrer la réponse en tant qu'enregistrement dans la table Pièce jointe \[sys_attachment\]. | | Nom de fichier de la pièce jointe | Nom de la pièce jointe créée par la réponse REST. Par exemple, rest-response.txt. Remarque : Ce champ est disponible lorsque l'option Enregistrer en tant que pièce jointe est sélectionnée. | | Enregistrement du fichier de la pièce jointe | Enregistrement cible auquel la pièce jointe est associée. L'enregistrement cible doit être une pastille de données de type Enregistrement. Par exemple, un enregistrement d'incident spécifique. Vous pouvez rechercher cet enregistrement dans une étape préalable ou le définir comme variable d'entrée. Les détails d'exécution du flux affichent la sys_id de l'enregistrement associé. Remarque : Ce champ est disponible lorsque l'option Enregistrer en tant que pièce jointe est sélectionnée. | [ ] {#rest-request-action-designer__table_p4n_cht_3cb} ## Évaluation de l'erreur d'action {#rest-request-action-designer__id_lg2_4s3_15b} En cas d'échec de cette étape : Type de données : Choice Option permettant de continuer à exécuter l'étape suivante ou d'accéder à l'évaluation des erreurs. Pour utiliser le code d'état ou le message de l'étape pour une condition d'erreur d'action personnalisée, reportez-vous à la section [Évaluation de l'erreur d'action](https://servicenow-prod.fluidtopics.net/SNatNVS0fhu8Ex212Wqh4w "Activez les actions pour intercepter les échecs d’étape et continuer à s’exécuter. Identifiez quand des conditions d’erreur spécifiques se produisent et renvoyez votre propre code de statut d’action, message d’état et état d’erreur."). ## Limites de taille de la réponse REST {#rest-request-action-designer__section_tps_xtd_kdb} Par défaut, le système limite à 5 Mo la taille des réponses REST qui ne sont pas enregistrées en tant que pièces jointes. Les réponses REST directes qui dépassent cette limite génèrent une erreur. Pour prendre en charge des tailles de réponse plus importantes, enregistrez la réponse en tant que pièce jointe ou augmentez la limite de taille de réponse avec la glide.pf.rest.response_payload_max_size propriété système. Cette propriété système prend en charge une valeur maximale de 10 240 Ko, ce qui limite la réponse REST à une taille de 10 Mo. ## Analyse d'une réponse REST {#rest-request-action-designer__section_umb_5q3_tzb} Les appels d'API REST renvoient des données dans le corps de la réponse. Les données du corps de la réponse sont généralement structurées au format JSON ou XML. Vous pouvez utiliser a [Étape Script](https://servicenow-prod.fluidtopics.net/SjGIbEKxxGnmFr259a7PWw "Ajoutez un JavaScript personnalisé à exécuter dans une action réutilisable. Bien que la plupart des actions et étapes de base correspondent à des cas d’utilisation courants, vous pouvez créer une étape de script pour exécuter un comportement qui n’est pas satisfait par les étapes de base.") pour analyser les données structurées en variables à utiliser ailleurs dans l'action ou dans un flux. Il est également possible d'analyser [XML parser step](https://www.servicenow.com/docs/access?context=xml-parser-step-action-designer&version=xanadu&pubname=xanadu-integrate-applications&ft:locale=en-US) le corps d'une réponse au format XML. La stratégie générale pour extraire les données de la réponse consiste à procéder comme suit. 1. Examinez le corps de la réponse pour sélectionner les données à renvoyer. 2. Créez des variables d'entrée et de sortie dans l'étape Script. * Créez une variable d'entrée à transmettre dans le corps de la réponse à partir de l'étape REST. * Créez des variables de sortie pour renvoyer les données de la réponse. {#rest-request-action-designer__ul_t5w_rr3_tzb} 3. Créez un script pour analyser et mapper les données. * Utilisez la méthode `JSON.parse()` dans une étape de script pour analyser le corps d'une réponse JSON. * Mappez les données analysées aux variables de sortie. {#rest-request-action-designer__ul_avq_tr3_tzb} 4. Créez des sorties d'action pour les variables de sortie afin de rendre les données disponibles à un flux. {#rest-request-action-designer__ol_ngr_lr3_tzb} Pour obtenir un exemple détaillé, consultez la section Analyse d'une réponse REST dans [REST dans la formation des développeurs Centre d'intégration](https://developer.servicenow.com/dev.do#!/learn/courses/tokyo/app_store_learnv2_rest_tokyo_rest_integrations/app_store_learnv2_rest_tokyo_rest_in_integrationhub/app_store_learnv2_rest_tokyo_rest_in_integrationhub_objectives).