Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.

...

Sv translation
languagefr

Fonction

Cet objet est utilisé pour effectuer un appel REST vers un service web.

Info
titleExpérience requise en matière de programmation

Remarque : une expérience en programmation est nécessaire pour utiliser cet objet. jtel ne fournit pas d'assistance aux développeurs dans le cadre du contrat d'assistance standard.

L'objet peut effectuer le type d'appels REST suivant :

  • GET
  • POST
  • PUT
  • DELETE

Il est possible de spécifier des paramètres, qui sont codés dans l'URL. Il est également possible de spécifier des en-têtes supplémentaires qui seront envoyés avec les en-têtes http lorsque l'appel REST est effectué.

Lorsque des opérations POST ou PUT sont effectuées, il est possible de spécifier les données qui sont envoyées dans le contenu de la requête http.

Lorsque l'appel revient, les en-têtes de la réponse sont fournis sous forme de variables qui peuvent être utilisées dans la demande à une étape ultérieure. Le corps de réponse est analysé s'il s'agit d'un XML ou d'un JSON valide, et est également fourni sous forme de variables. Il est possible de spécifier un préfixe pour le résultat (qui comprend les en-têtes), et un préfixe séparé pour les variables de contenu fournies.

Paramètres

ParamètreObjectif

Nom de l'objet

Le nom de cette instance d'objet

Méthode de requête

Choisissez la méthode de requête http à utiliser. Les méthodes GET, POST, PUT et DELETE sont supportées.

En-têtes

Un nombre quelconque d'en-têtes peut être spécifié et sera envoyé avec la demande http.

Les en-têtes doivent être spécifiés séparés par \n, si plus d'un en-tête sera utilisé.

Par exemple:

my-header-1: value1\n
my-header-2: value2
Paramètres

Les paramètres sont passés à la fin de l'URL, dans le formulaire :

http(s)://url?param1=value1&param2=value2

Les paramètres seront automatiquement encodés en URL selon les besoins.

DonnéesLes données ne sont requises que pour les opérations POST ou PUT. Les données sont transmises comme défini par le paramètre Content-Type.
Type de contenu

Ce paramètre est passé comme l'en-tête http "Content-Type", et définit comment les données incluses dans la requête POST ou PUT seront encodées.

Actuellement, ils sont soutenus :

application/json
application/x-www-form-urlencoded
text/plain
text/xml
Contenu des préfixes variables

Si le service web renvoie un contenu avec la réponse http, celle-ci sera fournie comme suit :

  • Dans la variable :

    $<VariablePrefixContent>.responseData
  • Si le XML est valide, alors comme variables du formulaire :

    $<VariablePrefixContent>.xmlStructure.xmlFieldName

  • Si JSON est valide, alors comme variables du formulaire :

    $<VariablePrefixContent>.jsonStructure.jsonFieldName

Le format exact fourni dépendra de la structure exacte retournée. Vous devez utiliser l'objet Variable Dump pour examiner les variables exactes qui sont analysées.


Exemple:

ArticleValeur
Contenu des préfixes variables
myContent
Contenu retourné
{ "tokenjeton": "QpwL5tke4Pnpja7X" }
Variables fournies
$myContent.responseData = { "token": "QpwL5tke4Pnpja7X" }
$myContent.token = QpwL5tke4Pnpja7X

Résultat du préfixe variable

Les en-têtes, la ligne d'état http et le code d'état sont stockés dans des variables préfixées avec la valeur fournie ici.

Les variables suivantes sont fournies automatiquement (en supposant une réponse http valide) :

  • $<VariablePrefixResult>.httpResponseCode - le code de réponse http
  • $<VariablePrefixResult>.httpResponse - la ligne de réponse http

Exemple Exemple :

ArticleValeur
Résultat du préfixe variable
myResult
ligne d'état http
HTTP/2 200 OK
En-têtes
content-type: application/json; charset=utf-8
set-cookie: __cfduid=d071fc20b4ada453375f3189252f1559d1556981085; expires=Sun, 03-May-20 14:44:45 GMT; path=/; domain=.test.com; HttpOnly
Variables fournies
$myResult.httpResponseCode = 200
$myResult.httpResponse = HTTP/2 200 OK
$myResult.content-type = application/json; charset=utf-8
$myResult.set-cookie = __cfduid=d071fc20b4ada453375f3189252f1559d1556981085; expires=Sun, 03-May-20 14:44:45 GMT; path=/; domain=.test.com; HttpOnly


Sorties

Sortie

Utilisé lorsque ...

200 OK

Une réponse de 200 OK a été reçue du serveur http.

AutreToute autre réponse a été reçue du serveur http.
ErreurUne erreur s'est produite. Aucune réponse, ou une réponse incorrecte, n'a été reçue du serveur http.

Variables fournies

Le préfixe est remplacé par le préfixe spécifié dans la définition de l'objet.

Variable

Contient

resultPrefix.httpResponseCode

Le code de réponse http.

resultPrefix.httpResponse

La réponse http.

resultPrefix.responseDataLe contenu http.
resultPrefix.*

Autres en-têtes http fournis par le service web.

contentPrefix.*Analyse des variables à partir d'une réponse JSON ou XML valide.

Release

Status
colourGreen
title3,14 à 04.05.2019