SW-REQUETE-http

Cette fonctionnalité a été actualisée en 04.16.22.

Voir anciennes versions ci-dessous.

Anciennes versions

Documentation

Avant la 04.16.22

T0-SW-REQUETE-http-181023-153900.pdf

BUT

Cette fonction permet d’exécuter une requête HTTP sur un service WEB externe, à partir d’une requête DIALOG.

Disponible dans tous les types de requête.

SYNTAXE

Variable = SW-REQUETE-HTTP (ACTION : action sur le service WEB

…

La syntaxe varie suivant la valeur du paramètre ACTION :

ACTION= PUT-BODY

Variable = SW-REQUETE-HTTP (ACTION= PUT-BODY

FORMAT : Format

[CLE : Clé dans la liste ]

[PATH : Chemin et nom du fichier ] )

ACTION= PUT-PARAM

Variable = SW-REQUETE-HTTP (ACTION= PUT-PARAM

CLE-PARAM : Clé du paramètre

VAL-PARAM : Valeur du paramètre)

ACTION= PUT-HEADER

Variable = SW-REQUETE-HTTP (ACTION= PUT-HEADER

CLE-HEADER : Clé Header

VAL-HEADER : Valeur Header)

ACTION= PUT-BASICAUTH

Variable = SW-REQUETE-HTTP (ACTION= PUT-BASICAUTH

LOGIN : Login

PASSWORD : Mot de passe)

ACTION= PUT-BEARERAUTH

Variable = SW-REQUETE-HTTP (ACTION= PUT-BEARERAUTH

PASSWORD : Mot de passe)

ACTION= NIV-TRACE

Variable = SW-REQUETE-HTTP (ACTION= NIV-TRACE

VALEUR : Valeur du niveau de trace)

ACTION= OPTION

Variable = SW-REQUETE-HTTP (ACTION= OPTION

CLE-OPTION : Clé de l’option

VAL-OPTION : Valeur de l’option)

ACTION= EXE-REQUETE

Variable = SW-REQUETE-HTTP (ACTION= EXE-REQUETE

METHODE : Méthode

URL : URL de la requête)

ACTION= GET-BODY

Variable = SW-REQUETE-HTTP (ACTION= PUT-BODY

FORMAT : Format

[CLE : Clé dans la liste ]

[PATH : Chemin et nom du fichier ] )

ACTION= GET-HEADER

Variable = SW-REQUETE-HTTP (ACTION= GET-HEADER

CLE-HEADER : Clé Header

S :VALEUR : Valeur)

ACTION= REINIT

Variable = SW-REQUETE-HTTP (ACTION= REINIT)

PARAMETRES

Paramètre	E/S	O	Type	Description
ACTION	E	Oui	Caractère	Action sur le service WEB externe. Cette action peut prendre l’une des valeurs suivantes : PUT-BODY : écriture du body d’envoi PUT-PARAM : ajout d’un paramètre URL PUT-HEADER : ajout d’un Header PUT-BASICAUTH : ajout authentification Basic PUT-BEARERAUTH : ajout authentification Bearer NIV-TRACE : niveau de trace OPTION : ajout option EXE-REQUETE : exécution d’une requête HTTP GET-BODY: lecture du body de retour GET-HEADER : lecture du Header REINIT : réinitialisation requête HTTP
FORMAT	E	Non	Caractère	Format des données reçues. Ce format peut prendre les valeurs suivantes : TEXTE XML JSON FICHIER
CLE	E	Non	Caractère	Clé dans la liste. Paramètre utilisé seulement pour les formats TEXTE et XML. Peut être donné par une variable locale, une constante globale ou une constante locale.
PATH	E	Non	Caractère	Chemin complet et nom du fichier. Paramètre utilisé seulement pour le format FICHIER. Peut être donné par une variable locale, une constante globale ou une constante locale.
CLE-PARAM	E	Non	Caractère	Clé du paramètre à envoyer. Paramètre utilisé seulement pour l’action PUT-PARAM. Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
VAL-PARAM	E	Non	Caractère	Valeur du paramètre à envoyer. Paramètre utilisé seulement pour l’action PUT-PARAM. Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
CLE-HEADER	E	Non	Caractère	Cl é du Header. Paramètre utilisé seulement pour l’action PUT-HEADER. Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
VAL-HEADER	E	Non	Caractère	Valeur du Header. Paramètre utilisé seulement pour l’action PUT-HEADER. Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
LOGIN	E	Non	Caractère	Login. Paramètre utilisé seulement pour l’action PUT-BASICAUTH. Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
PASSWORD	E	Non	Caractère	Mot de passe. Paramètre utilisé seulement pour les actions PUT-BASICAUTH et PUT-BEARERAUTH. Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
VALEUR	E	Non	Numérique	Valeur du niveau de trace. Paramètre utilisé seulement pour l’action NIV-TRACE. Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
CLE-OPTION	E	Non	Caractère	Cl é de l’option. Paramètre utilisé seulement pour l’action OPTION. Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
VAL-OPTION	E	Non	Caractère	Valeur de l’option. Paramètre utilisé seulement pour l’action OPTION. Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
METHODE	E	Non	Caractère	Méthode d’exécution de la requête HTTP. Paramètre utilisé seulement pour l’action EXE-REQUETE. . Cette action peut prendre l’une des valeurs suivantes : GET PUT POST DELETE PATCH
URL	E	Non	Caractère	URL de la requête HTTP. Paramètre utilisé seulement pour l’action EXE-REQUETE Ce paramètre peut être donné par une variable locale, une constante globale ou une constante locale.
S :VALEUR	S	Non	Caractère	Valeur du Header. Ce paramètre ne peut être donné que par une variable locale

NOTES

La fonction retourne dans la variable résultat :

Le code erreur DIAPASON et le libellé associé à l’erreur, lors de toute anomalie d’exécution
Vide si tout s’est bien passé

EXEMPLE

VLO.SepElmnt = CHR( VALEUR= CLO.135 )

VLO.refRacine = CLO."$RACINE$"

COMMENTAIRE : "************* TESTS FONCTION SW-REQUETE-HTTP"

VLO.RetourFonction = SW-REQUETE-HTTP( ACTION= PUT-BASICAUTH , LOGIN= CLO."test-isia" , PASSWORD= VLO..PassWord )

VLO.RetourFonction = SW-REQUETE-HTTP( ACTION= PUT-PARAM , CLE-PARAM= CLO."clientApplicationSecretCode" , VAL-PARAM= VLO.Client )

VLO.RetourFonction = SW-REQUETE-HTTP( ACTION= EXE-REQUETE , METHODE= GET , URL= VLO.URL )

VLO.RetourFonction = SW-REQUETE-HTTP( ACTION= GET-BODY , FORMAT= TEXTE , CLE= CLO."ret" )

POUR CHAQUE LST WFFicContenu :

VLO.Ligne = WFFicContenu.ContenuLigne

FIN_BLOC

COMMENTAIRE : "****************** REINIT & PURGE"

VLO.RetourFonction = SW-REQUETE-HTTP( ACTION= REINIT )