Propriétés
| Nom | Type | Description |
|---|---|---|
| Url | string | L’URL de la ressource. |
| Method | string | Type de requête (par exemple GET ou POST). |
| AuthToken | string | Jeton d’authentification (si une authentification du service externe est requise). |
| AuthScheme | string | Schéma d’authentification. |
| ThrowExceptionOnFailed | boolean | Indique s’il faut lever une exception lorsque le service externe renvoie un code d’erreur comme statut de réponse HTTP. S’il est défini sur False, aucune exception n’est levée et le code d’état HTTP est stocké dans la propriété Status. Valeur par défaut : True. |
| Timeout | number | Délai d’expiration de la réponse, en minutes. Valeur par défaut : 1 minute. Important ! La valeur du délai d’expiration de la requête ne peut pas dépasser la limite de temps d’exécution du script (600 secondes). |
| ResponseText | string, lecture seule | Résultats de la réponse au format texte. |
| ResponseType | string, lecture seule | Type de réponse renvoyée par le service, par exemple « application/json ». |
| Status | number | Code de statut de la réponse HTTP du service externe. Si ThrowExceptionOnFailed est défini sur True, un code d’erreur lèvera une exception et la transaction sera interrompue. Le texte du message d’erreur peut être consulté dans Skill Monitor. |
Méthodes
| Name | Description |
|---|---|
| AppendStringContent(string data, string contentName); | Ajoute une chaîne multipart/form-data au corps de la requête (par défaut, le type de contenu est défini sur application/json avec encodage UTF-8). Le paramètre contentName spécifie le nom du champ dans un format transmissible. |
| AppendStringContent(string data, string contentName, ContentEncoding contentEncoding, string mediaType?); | Ajoute une chaîne multipart/form-data au corps de la requête et permet de préciser l’encodage. Si le type de contenu n’est pas indiqué, il est défini par défaut sur « application/json ». |
| AppendFileContent(DocumentExportResult documentExportResult, string contentName, string mediaType?); | Ajoute des données binaires multipart/form-data au corps de la requête. Le type de contenu est défini automatiquement en fonction de l’extension du fichier transmis. Si nécessaire, le type de contenu peut être défini à l’avance à l’aide du paramètre optionnel mediaType. |
| AppendFileContent(BinaryFile binaryFile, string contentName, string mediaType?); | Ajoute au corps de la requête les données binaires suivantes : l’image source importée dans la transaction ou l’image contenue dans le champ de type Picture. Le type de contenu est défini automatiquement en fonction de l’extension du fichier importé. Si nécessaire, le type de contenu peut être défini à l’avance à l’aide du paramètre optionnel mediaType. |
| AppendSourceFileContent(string contentName, string mediaType?); | Ajoute au corps de la requête les données binaires de l’image source importée dans la transaction. Le type de contenu est défini automatiquement en fonction de l’extension du fichier importé. Si nécessaire, le type de contenu peut être défini à l’avance à l’aide du paramètre optionnel mediaType. Important : cette méthode est obsolète. Elle n’a accès qu’au premier fichier de la transaction. Utilisez plutôt la méthode AppendFileContent(). |
| SetHeader(string name, string value); | Définit des en-têtes HTTP supplémentaires pour la requête. Cette méthode doit être appelée pour chaque en-tête. |
| Send(); | Envoie la requête HTTP. |