DIAPASON 04.16
DIAPASON 04.16
Breadcrumbs

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 )