avant la version 3.27 | |
---|
Image Added
| Image Added |
FonctionCet objet est utilisé pour effectuer un appel REST vers un service web. Info |
---|
title | Expé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 Image Removed
FunctionThis object is used to make a REST call to a web service. Info |
---|
title | Programming Experience Required |
---|
| Note: you will require programming experience to use this object. jtel does not provide developer support as part of the standard support contract. | The object can perform the following type of REST calls : It is possible to specify parameters, which are coded in the URL. Also it is possible to specify additional headers which will be sent with the http headers when the REST call is made. When POST or PUT operations are performed, data can be specified which is sent in the content of the http request. When the call returns, the headers from the response are provided as variables which can be used in the application at a later step. The response body is parsed if valid XML or JSON, and is also provided as variables. It is possible to specify a prefix for the result (which includes the headers), and a separate prefix for the content variables provided. Parameters 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ètre | Objectif | 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 |
Parameter | Purpose | Object Name | The name of this object instance | Request Method | Choose the http request method to be used. GET, POST, PUT and DELETE are supported. | Headers | Any number of headers can be specified and will be sent with the http request. Headers must be specified separated by \n, if more than one header will be used. For example: my-header-1: value1\n my-header-2: value2 |
Parameters | Paramètres | Les paramètres sont passés à la fin de l'URL, dans le formulaire | Parameters are passed at the end the URL, in the form : http(s)://url?param1=value1¶m2=value2 |
The parameters will automatically be URL encoded as required. Les paramètres seront automatiquement encodés en URL selon les besoins. | Données | Les 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 |
Data | Data is only required for POST or PUT operations. The data is passed as defined by the Content-Type parameter. | Content-Type | This parameter is passed as the http header "Content-Type", and defines how the data included in the POST or PUT request will be encoded. Currently supported are : application/json application/x-www-form-urlencoded text/plain text/xml |
Variable Prefix Content | Contenu des préfixes variables | Si le service web renvoie un contenu avec la réponse http, celle-ci sera fournie comme suit : |
If the web service returns content with the http response, then this will be provided as follows: In the If valid then as variables of the formIf valid then as variables of the formThe exact format provided will depend on the exact structure returned. You should use the Variable Dump Object to examine the exact variables which are parsed. Example: 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: Article | Valeur |
---|
Contenu des préfixes variables | myContent | Contenu retourné | { "jeton |
|
Item | Value |
---|
Variable Prefix Content | myContent | Returned Content | { "tokenProvided Variables fournies | $myContent.responseData = { "token": "QpwL5tke4Pnpja7X" } $myContent.token = QpwL5tke4Pnpja7X |
|
Variable Prefix Result | The headers and the http status line and status code are stored in variables prefixed with the value provided here. The following variables are provided automatically (assuming a valid http response
| 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) : | thehttpresponsecodethehttpresponselineExampleItemValue | Valeur |
---|
Résultat du préfixe variable |
| Variable Prefix Result | myResult | ligne d'état http |
| Status LineHeadersEn-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 |
| Provided 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 |
|
OutputsSorties OutputUsed when Continue | A record is found | Not Found | No record for the specified caller was found using the criteria specified (ACD groups and time period) | Error | An error occurred. This is most likely due to the incorrect specification of the ACD groups - either missing commas at the relevant positions, or specifying variables which could not be evaluated. | Variables ProvidedPrefix is replaced with the prefix specified in the object definition. 200 OK | Une réponse de 200 OK a été reçue du serveur http. | Autre | Toute autre réponse a été reçue du serveur http. | Erreur | Une erreur s'est produite. Aucune réponse, ou une réponse incorrecte, n'a été reçue du serveur http. |
Variables fourniesLe 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 |
Variable | Contains | resultPrefix.httpResponseCode | The http response code. | resultPrefix.httpResponse | The response. | resultPrefix.responseData | The http contentLe contenu http. | resultPrefix.command | La commande CURL utilisée pour la référence / le débogage. | resultPrefix.* | Other http headers provided by the web serviceAutres en-têtes http fournis par le service web. | contentPrefix.* | Parsed variables from a valid JSON or XML responseAnalyse des variables à partir d'une réponse JSON ou XML valide. |
Release. ab |