Point de terminaison à la demande pour les Tâche API

Appelez des Tâches API instantanément avec un point de terminaison. Cela permet de lancer et d'exécuter dynamiquement des Tâches API à la demande à l'aide de l'API de déploiement. Cette approche permet de rationaliser les flux de travail et d'améliorer l'efficacité des ressources par rapport aux déploiements statiques traditionnels.

Principaux avantages

  • Déploiement programmatique : déployez une Tâche API de n'importe où et à la demande à l'aide de votre client API préféré.
  • Traitement :
    • Les automatisations ne sont activées qu'en cas de besoin, ce qui garantit une utilisation optimale des ressources. Cela signifie qu'elles ne sont pas constamment déployées dans le cloud, préservant ainsi des ressources. Au lieu de cela, elles sont chargées et exécutées à chaque demande.
    • En période de forte affluence, les automatisations sont placées dans une file d'attente et exécutées dès que les périphériques sont disponibles, ce qui garantit des opérations fluides même en cas de forte charge. Vous pouvez consulter la progression des automatisations sur la page Activité.
    • La licence Premium permet de faire évoluer votre automatisation et d'accéder à un plus grand pool de ressources cloud qui peuvent exécuter plusieurs instances de votre Tâche API, en augmentant la concurrence et en vous permettant de traiter plus de demandes de Tâche API simultanément.
  • Cas d'utilisation actuels :
    • Traitements par lots (analyse des données de vente, génération de rapports, etc.)
    • Tâches planifiées
    • Situations où une réponse immédiate n'est pas indispensable
Remarque : Pour activer le déploiement à la demande de Tâche API au sein d\'un processus, générez une clé d\'enregistrement dans Administration > Paramètres > Installation en masse de l\'agent Bot > Générer une nouvelle clé et cliquez sur Enregistrer les modifications.

Authentifier

Obtenez les informations d'authentification nécessaires pour interagir avec l'API de déploiement. Il s'agit généralement de jetons d'accès ou de clés API. L'exemple suivant déploie une Tâche API à la demande sur un périphérique cloud. Vous pouvez également transmettre des variables aux robots lorsqu'ils sont déployés.

POST https://{{ControlRoomURL}}/v4/automations/deploy

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

Tous les appels d'API doivent contenir soit un jeton d'authentification de l'API d'authentification (qui génère un JSON Web Token), soit un Bearer token des services OAuth. Vous ne pouvez pas utiliser les deux ensemble dans une API.

Composer la demande à la demande

Demande : 
{
  "botId": 121,
  "automationName": "SAMPLE_APITASK",
  "description": "My first API Task deploy using api",
  "botLabel": "string",
  "executionType": "RUN_NOW",
  "automationPriority": "PRIORITY_MEDIUM",
  "headlessRequest": {
    "numberOfExecutions": 1,
    "queueOnSlotsExhaustion": false,
    "sharedRunAsUserId": 12
  },
  "botInput": {
    "inputVar": {
      "type": "STRING",
      "string": "PassingString"
    }
  }
}
Remarque :

Les demandes de déploiements d'automatisations peuvent être faites sans aucun champ d'entrée. Si vous spécifiez des entrées, veillez à ce que la variable de l'automatisation soit marquée comme entrée pour que la Tâche API puisse recevoir ces valeurs mappées. De plus, le nom de la variable dans la Tâche API doit correspondre à la valeur mappée dans le corps de la demande.

Paramètres de la demande
Paramètre Type Obligatoire Description
botId Entier Oui

ID de l'automatisation à déployer.
automationName Chaîne Non Nom de l'automatisation à déployer. Vous pouvez saisir un nom pour identifier facilement votre automatisation. Par exemple, SAMPLE_APITASK, FIRST_API_TASK, apitask-on-demand.
description Chaîne Non Description de l'automatisation à déployer. Exemple : My first API Task deploy using api
botLabel Chaîne Non Étiquette de l'automatisation à déployer.
executionType Chaîne Non Type d'exécution associé au robot.
automationPriority Chaîne Non Priorité d'automatisation. Ce paramètre est défini sur PRIORITY_MEDIUM par défaut. Les valeurs possibles pour automationPriority comprennent : PRIORITY_MEDIUM, PRIORITY_HIGH et PRIORITY_LOW.
Objet headlessRequest.
numberOfExecutions Entier Non Nombre d'exécutions à effectuer pour une demande à la demande spécifique (sans interface).
queueOnSlotsExhaustion booléen Non Indique si le déploiement doit être mis en file d'attente.
sharedRunAsUserId Entier Non apitaskrunner pour établir le contexte RunAsUser pour les Tâches API. Pour en savoir plus sur apitaskrunner, consultez la rubrique Utilisateur Exécuter en tant que pour les tâches d'API (apitaskrunner).
Remarque : Cet utilisateur RunAsUser ne nécessite pas de licence Bot Runner.
Objet botInput
type N'importe lequel Non Par défaut, il s'agit de STRING. Les valeurs possibles pour le type incluent : STRING, NUMBER, BOOLEAN, FILE, ITERATOR, LIST, DICTIONARY, TABLE, VARIABLE, CONDITIONAL, WINDOW, TASKBOT, DATETIME, UIOBJECT, RECORD, EXCEPTION, CREDENTIAL, COORDINATE, IMAGE, REGION, PROPERTIES, TRIGGER, CONDITIONALGROUP, FORM, FORMELEMENT, HOTKEY, and WORKITEM.
Réponse 
{
  "deploymentId": "320a2149-aa44-41ab-af9b-f9343ae2581b",
  "automationName": "SAMPLE_APITASK"
}
Paramètres de réponse
Paramètre Type Description
deploymentId Chaîne ID de déploiement créé.
automationName Chaîne Nom de l'automatisation déployée. Si ce nom n'est pas fourni dans la demande, un nom aléatoire est assigné à l'automatisation déployée.
Vous pouvez tester ce point de terminaison dans l'interface Swagger, qui est incluse dans toutes vos instances Control Room.
Conseil : Accédez à Swagger en naviguant vers votre instance Control Room et en ajoutant /swagger/ à la fin de l'URL.
https://{{ControlRoomURL}}/swagger/

Consultez la page d'activité de votre Control Room pour suivre la progression de votre exécution à la demande (sans interface) depuis Mis en file d'attente >> En cours >> Terminé.

API-Task-Activity-page

Pour plus de détails sur l'API de déploiement, consultez API de déploiement de robots (V4).