Appeler service REST

Appeler service REST
Cette tâche de workflow permet aux administrateurs d'appeler un service Web externe depuis une tâche de workflow automatique sans programmation.

Paramètres généraux
Vous trouverez ici des informations complémentaires sur les paramètres de tâche de workflow généraux :
Tâches de workflow

Modifier
Ouvre une boîte de dialogue permettant de configurer les paramètres de l’appel REST.

Icône	Description
	Ajoute un nouvel appel REST.
	Modifie une demande REST.
	Supprime une demande REST.
	Décale la demande REST vers le haut dans la liste. Les appels sont exécutés de haut en bas par défaut.
	Décale la demande REST vers le bas dans la liste.

Nom :
Ajoutez le nom de l'appel REST.

ID de génération de script
Ajoutez un ID de génération de script pour l'appel REST.

Informations d'identification
Sélectionnez des informations d'identification mémorisées dans le référentiel central pour vous authentifier auprès du fournisseur du point de terminaison utilisé pour l'appel.
Informations d'identification

Verbe
Sélectionnez la méthode de requête HTTP dans le menu déroulant.

Options du menu déroulant

Requête	Fonction
GET	Récupère les données d'un serveur dans la ressource indiquée.
POST	Envoie des données au serveur d'API pour créer ou mettre à jour une ressource.
PUT	Envoie des données à l'API pour mettre à jour ou créer une ressource. Ce qui distingue les deux options est que les requêtes PUT produisent toujours le même résultat.
DELETE	Supprime la ressource dans la ressource indiquée.
PATCH	Similaire aux options POST et PUT, mais ne s'applique qu'à des modifications partielles de la ressource.

Champ URL
Espace réservé à l'URL de l'appel de Web Service.

Macros
Ouvre une boîte de dialogue contenant toutes les macros disponibles.

Script
Vous pouvez créer un script d'initialisation qui sera exécuté avant l'exécution des affectations de champs. Vous pouvez également définir ici des variables et fonctions que pourront utiliser les scripts d'affectation.

Tester
Exécute un appel d'API test qui vérifie s'il est possible de communiquer avec Web Service et s'il est possible d'obtenir une réponse. Ouvre une boîte de dialogue pour illustrer le résultat du test.

Paramètres
Indique les paramètres requis pour envoyer et recevoir.

Ajouter
Ajoutez un paramètre.

Supprimer
Supprimez un paramètre.

En-tête
Affiche les en-têtes requis pour envoyer ou recevoir.

Document
Si un document doit être envoyé à un service tiers via l’appel REST, configurez le contenu et la méthode d’envoi.

Corps
Affiche les valeurs et objets JSON.

Insérer
Sélectionnez un objet ou une valeur JSON à afficher.

Supprimer
Supprimez un objet ou une valeur JSON.

Charger la requête JSON
Téléchargez un fichier JSON dans Corps. La valeur JSON peut être extraite d’un fichier sur votre périphérique ou ajoutée directement depuis votre Presse-papiers.

Réponse
Définissez la réponse à recevoir du service tiers.

Codes de réussite
Recense les codes que l'appel d'API doit considérer comme une réussite.

Charger la réponse JSON
Téléchargez un fichier JSON dans Corps. La réponse JSON peut être chargée à partir d’un fichier sur votre périphérique ou ajoutée directement depuis votre Presse-papiers.

Remarque :

Les appels REST ont pour objet d’effectuer des appels sortants aux applications tierces. Bien qu’il soit possible d’appeler l’API Therefore à l’aide d’appels REST, la fonction répond mal aux besoins avancés, en particulier lorsque vous manipulez des données d’index.
Pour que les applications tierces accèdent à Therefore™ sans faire appel à l'authentification à deux facteurs, elles requièrent un compte de service. Pour plus d'informations, reportez-vous à la page de référence ci-dessous :
Utilisateurs et groupes

Génération de scripts - Objets et fonctions

Type d'objet	Nom	Description	Utilisé avec
Appel REST	Code d'état	Renvoie le code d'état actuel.	Script
	GetResponseHeader
	NextRequest
	ExecCounter
	ExitSuccess
	ScriptError
Données d'index	SetField	Définit la valeur du champ de données d'index.	Script
	GetField	Extrait la valeur actuelle des données d'index du champ spécifié.	Script
	GetFieldEx	Extrait la valeur actuelle des données d'index du champ spécifié sans appliquer de conversion rétrocompatible.	Script
	SetCategory	Extrait la catégorie du document en cours. Vous pouvez utiliser un nombre entier (ID de la catégorie) ou une chaîne (nom de la catégorie).	Script
	SetCaseNo	Définit le numéro de dossier de cet objet de type données d'index.	Script
	GetCategoryName	Extrait le nom de la catégorie à laquelle appartient l'objet de type données d'index.	Script
	GetTableValue	Extrait la valeur actuelle des données d'index du champ spécifié issu de la ligne spécifiée.	Script
	SetTableValue	Définit la valeur du champ de la table de données d'index à la ligne spécifiée.	Script
Objet Workflow	AssignedToUserDisplayName	Renvoie le nom d'affichage de l'utilisateur auquel est assignée la tâche.	Script
	AssignedToUserName	Renvoie le nom de l'utilisateur auquel est assignée la tâche.	Script
	InitiatorDisplayName	Renvoie le nom d'affichage de l'initiateur du workflow.	Script
	InitiatorEmail	Renvoie l'adresse e-mail de l'initiateur du workflow.	Script
	InitiatorName	Renvoie le nom d'utilisateur de l'initiateur du workflow.	Script
	InstanceNo	Renvoie le numéro d'instance du workflow.	Script
	MainDocNo	Renvoie le numéro du document principal associé au workflow.	Script
	PreviousTaskUserDisplayName	Renvoie le nom d'affichage de l'utilisateur qui a exécuté la tâche précédente.	Script
	PreviousTaskUserEmail	Renvoie l'adresse e-mail de l'utilisateur qui a exécuté la tâche précédente.	Script
	PreviousTaskUserDomain	Renvoie le domaine de l'utilisateur qui a exécuté la tâche précédente.	Script
	PreviousTaskUserName	Renvoie le nom de l'utilisateur qui a exécuté la tâche précédente.	Script
	ProcessDueDateTime	Renvoie la date et l'heure d'échéance du processus de workflow.	Script
	ProcessDueDate	Renvoie la date d'échéance du processus de workflow.	Script
	ProcessName	Renvoie le nom du processus de workflow.	Script
	ProcessStartDate	Renvoie la date de début du processus de workflow.	Script
	ProcessStartDateTime	Renvoie la date et l'heure de début du processus de workflow.	Script
	ServerName	Renvoie le nom de l'ordinateur sur lequel s'exécute la tâche de workflow.	Script
	TaskDueDate	Renvoie la date d'échéance de la tâche.	Script
	TaskDueDateTime	Renvoie la date et l'heure d'échéance de la tâche.	Script
	TaskNameTo	Renvoie le nom de la tâche suivante.	Script
	TaskStartDate	Renvoie la date de début de la tâche.	Script
	TaskStartDateTime	Renvoie la date et l'heure de début de la tâche.	Script
	UserDisplayName	Renvoie le nom d'affichage de l'utilisateur du workflow.	Script
	UserDomain	Renvoie le nom du domaine de l'utilisateur du workflow.	Script
	UserEmail	Renvoie l'adresse e-mail de l'utilisateur du workflow.	Script
	UserName	Renvoie le nom de l'utilisateur du workflow.	Script
	WebClientDocLink	Renvoie un lien vers le document principal du workflow.	Script
	WebClientLink	Renvoie un lien vers le document Therefore™ du workflow.	Script
	WebPortalDocLink	Renvoie un lien vers le document principal du workflow dans le portail.	Script
	CaseNo	Renvoie le numéro de dossier d'un workflow de dossier.	Script
	TenantName	Renvoie le nom du locataire.	Script
	EFormLink	Renvoie le lien racine vers Therefore™ eForms.	Script
	WebClientLinkDynamicView	Renvoie un lien vers l'instance de workflow dans l'instance plus récente de Therefore™ Web Client.	Script
	WebClientDocLinkDynamicView	Renvoie un lien vers le document principal de l'instance de workflow dans l'instance plus récente de Therefore™ Web Client.	Script
	CategoryNo	Renvoie le numéro de la catégorie dans laquelle s'exécute le workflow.	Script
	CaseDefNo	Renvoie le numéro de la définition de dossier dans laquelle s'exécute le workflow.	Script
	eSignatureDocID	Renvoie l'ID du dernier document délivré par le fournisseur de signature électronique.	Script
	InitiatorDomain	Renvoie le nom du domaine de l'initiateur du workflow.	Script
	TokenNo	Renvoie le numéro du jeton de l'instance de workflow.	Script
	AddCommentToWorkflow	Ajoute un commentaire à l'instance de workflow.	Script
	GetAccessToken	Génère un jeton d'accès pour ouvrir l'instance de workflow ou le document/le dossier principal à l'aide de WebAPI. Vous pouvez définir la durée de vie attendue en minutes. La valeur maximale est de 60 minutes.	Script
	GetDocumentText	Extrait le contenu de texte brut d'un document. Prend en charge un autre paramètre - StreamNo: Sa valeur par défaut est 0, qui renvoie le texte de tous les flux. Si vous spécifiez un numéro de flux spécifique, seul le texte brut de ce flux est renvoyé. Cette fonction ne prend pas en charge la reconnaissance optique de caractères.	Script
Assistance	ToDate	Convertit une chaîne au format spécifié en date et utilise « D » (jour), « M » (mois) et « Y » (année). Les séparateurs font l'objet d'une interprétation stricte.	Script
	ToFloat	Convertit en nombre flottant une chaîne au format spécifié.	Script
	ToDecimal	Convertit en nombre décimal une chaîne au format spécifié.	Script
	ToDateTime	Convertit une chaîne en date et heure à l'aide du LCID spécifié.	Script
	DecimalAdd	Ajoute deux nombres décimaux. (nombre décimal1 + nombre décimal2)	Script
	DecimalSub	Soustrait deux nombres décimaux. (nombre décimal1- nombre décimal2)	Script
	DecimalMul	Multiplie deux nombres décimaux. (nombre décimal1 * nombre décimal2)	Script
	DecimalDiv	Divise deux nombres décimaux. (nombre décimal1/nombre décimal2)	Script
	DecimalCmp	Compare deux nombres décimaux. Renvoie 0 s'ils sont égaux. Renvoie -1 si le nombre décimal de gauche est inférieur au nombre décimal de droite. Renvoie 1 si le nombre décimal de gauche est supérieur au nombre décimal de droite.	Script
	AdjustClientTimeDifference	Renvoie le paramètre du serveur « Time difference of clients » (décalage horaire des clients). Cette valeur peut être ajoutée à une valeur Datetime existante pour calculer le fuseau horaire du client.	Script
	Date	Renvoie la date en cours.	Script
	GetSystemVariable	Renvoie la valeur de la variable système spécifiée.	Script