Requêtes relatives aux planifications

Démarrage d'une planification avec affectation dynamique du Robot

La requête suivante vous permet de créer une planification nommée ApiTest, sur le fuseau horaire GMT Standard Time, qui est déclenchée tous les 5 mois, le dimanche.

Le paramètre StartStrategy vous permet de choisir le mode d'exécution de la tâche.

Valeurs possibles pour StartStrategy

Valeur (Value)	Nom	Description	Contexte du dossier
-1	Tous les robots (All Robots)	Exécute la tâche une fois pour chaque robot présent dans l'environnement du processus.	Classique
0	Robots personnalisés	Exécute la tâche une fois sur chacun des robots spécifiés. Pour spécifier les robots, incluez les ID de robot en tant que valeurs dans ExecutorRobots. Par exemple, `"ExecutorRobots" : [ {"Id" : 44881	Classique
1	1 robot	Exécute la tâche sur un robot sélectionné dynamiquement de n’importe quel utilisateur qui a accès au dossier où se trouve le processus. Vous pouvez également définir la tâche pour qu'elle s'exécute sur le robot que vous spécifiez dans MachineRobots. Consultez l'échantillon de corps de demande ci-dessous pour voir un exemple.	Moderne
tout autre nombre	Allocation dynamique	Crée le nombre spécifié de tâches et choisit dynamiquement les robots sur lesquels les exécuter à partir des robots disponibles dans le dossier moderne du processus ou à partir des robots dans l’environnement pour les dossiers classiques. Pour les dossiers modernes, vous pouvez également spécifier un ou plusieurs modèles de machine, des robots ou à la fois des modèles de machine et des robots à l’aide du paramètre de liste MachineRobots. Dans ce cas, la valeur StartStrategy représente le nombre de fois où la tâche doit être exécutée sur chaque robot ou combinaison robot-machine spécifiée. Ce n’est pas possible pour les dossiers classiques et, s’il est spécifié, le paramètre ExecutorRobots est ignoré.	classique ou moderne

Publier

https://{yourDomain}/odata/ProcessSchedules

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

{
  "Name":"ApiTest",
  "ReleaseId":75,
  "ReleaseName":"BlankProcess_DocEnv",
  "StartProcessCron":"0 0 0 ? 1/5 SUN *",
  "StartProcessCronDetails":"{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
  "StartStrategy":15,
  "ExecutorRobots":[],
  "MachineRobots":[
    {
      "MachineId":null,
      "MachineName":null,
      "RobotId":44880,
      "RobotUserName":"acme\\john.doe"
    }
  ],
  "StopProcessExpression":"",
  "StopStrategy":null,
  "TimeZoneId":"GMT Standard Time"
}

Remarque :

Pour déterminer la valeur correcte du paramètre TimeZoneId , envoyez une requête GET au point de terminaison /odata/Settings/UiPath.Server.Configuration.OData.GetTimezones . Dans la réponse, localisez l'entrée correspondant à votre fuseau horaire et copiez la chaîne dans le champ Value . Ensuite, lorsque vous créez la planification, utilisez la chaîne comme valeur du paramètre TimeZoneId dans le corps de la demande.

Codes de réponse

200 OK

Corps de la réponse

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#ProcessSchedules/$entity",
    "Enabled": true,
    "Name": "ApiTest",
    "ReleaseId": 75,
    "ReleaseKey": "00000000-0000-0000-0000-000000000000",
    "ReleaseName": null,
    "PackageName": null,
    "EnvironmentName": null,
    "EnvironmentId": "0",
    "StartProcessCron": "0 0 0 ? 1/5 SUN *",
    "StartProcessCronDetails": "{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
    "StartProcessCronSummary": null,
    "StartProcessNextOccurrence": null,
    "StartStrategy": 15,
    "StopProcessExpression": "",
    "StopStrategy": null,
    "ExternalJobKey": "8cda4b35-e835-445b-b477-1ea0961d62e5",
    "TimeZoneId": "GMT Standard Time",
    "TimeZoneIana": "Europe/London",
    "UseCalendar": false,
    "StopProcessDate": null,
    "InputArguments": "{}",
    "Id": 43
}

Démarrage d'une planification avec des valeurs de paramètres d'entrée

La requête POST suivante effectuée vers le point de terminaison /odata/ProcessSchedules permet de créer une planification activée avec le nom « API_schedule_test » dans le processus avec l'ID 55, tout en ajoutant également des valeurs personnalisées pour certains paramètres de processus. La planification démarre toutes les cinq minutes sur tous les Robots disponibles et ne prend pas en compte les jours non ouvrables.

Remarque :

Un maximum de 10 000 caractères est accepté pour la longueur entière de la représentation JSON des paramètres d'entrée, y compris les noms des arguments, tous les caractères avec échappement, les espaces, les crochets et les valeurs d'arguments.

Publier

https://{yourDomain}/odata/ProcessSchedules

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

{
      "Enabled": true,
      "Name": "API_schedule_test",
      "ReleaseId": 55,
      "ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
      "ReleaseName": "input_output_test_DocEnv",
      "PackageName": "input_output_test",
      "EnvironmentName": "DocEnv",
      "EnvironmentId": "7",
      "StartProcessCron": "0 0/5 * 1/1 * ? *",
      "StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
      "StartProcessCronSummary": "Every 5 minutes",
      "StartProcessNextOccurrence": null,
      "StartStrategy": 0,
      "StopProcessExpression": "",
      "StopStrategy": null,
      "ExternalJobKey": "af486c19-c797-48cd-b586-cfb7a12110a2",
      "TimeZoneId": "Morocco Standard Time",
      "TimeZoneIana": "Africa/Casablanca",
      "UseCalendar": false,
      "StopProcessDate": null,
      "InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555}",
      "Id": 37
    }

Remarque :

Pour déterminer la valeur correcte du paramètre TimeZoneId , envoyez une requête GET au point de terminaison /odata/Settings/UiPath.Server.Configuration.OData.GetTimezones . Dans la réponse, localisez l'entrée correspondant à votre fuseau horaire et copiez la chaîne dans le champ Value . Ensuite, lorsque vous créez la planification, utilisez la chaîne comme valeur du paramètre TimeZoneId dans le corps de la demande.

Codes de réponse

200 OK

Corps de la réponse

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#ProcessSchedules/$entity",
    "Enabled": true,
    "Name": "API_schedule_test",
    "ReleaseId": 55,
    "ReleaseKey": "00000000-0000-0000-0000-000000000000",
    "ReleaseName": null,
    "PackageName": null,
    "EnvironmentName": null,
    "EnvironmentId": "0",
    "StartProcessCron": "0 0/5 * 1/1 * ? *",
    "StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
    "StartProcessCronSummary": "Every 5 minutes",
    "StartProcessNextOccurrence": null,
    "StartStrategy": 0,
    "StopProcessExpression": "",
    "StopStrategy": null,
    "ExternalJobKey": "7ecbff8d-832d-41e1-a3ed-aee0957caffe",
    "TimeZoneId": "Morocco Standard Time",
    "TimeZoneIana": "Africa/Casablanca",
    "UseCalendar": false,
    "StopProcessDate": null,
    "InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555,\"inOutTry\":\"2012-04-23T18:25:43.511Z\"}",
    "Id": 37
}