- Démarrage
- Authentification
- Définition Swagger
- API Orchestrator
- Demandes d'alertes
- Requêtes relatives aux actifs
- Requêtes de calendriers
- Requêtes relatives aux environnements
- Requêtes de dossiers
- Requêtes de tâches globales
- Requêtes relatives aux tâches
- Requêtes relatives aux bibliothèques
- Requêtes relatives aux licences
- Requêtes relatives aux paquets (Packages Requests)
- Requêtes relatives aux autorisations
- Demandes relatives aux espaces de travail personnels
- Requêtes relatives aux processus
- Demandes d'éléments de la file d'attente
- Queue retention policy requests
- Requêtes relatives aux Robots
- Requêtes relatives aux rôles (Roles Requests)
- Requêtes relatives aux planifications
- Requêtes relatives aux paramètres
- Requêtes de compartiments de stockage
- Requêtes de tâches
- Demandes de catalogues de tâches
- Demandes de formulaires de tâches
- Requêtes relatives aux locataires
- Requêtes relatives aux transactions
- Requêtes relatives aux utilisateurs
- Requêtes relatives aux Webhooks
- API de gestion de plate-forme

Guide de l'API Orchestrator
Requêtes relatives aux tâches
linkDemande de tâches démarrées par un Robot spécifique
linkEn fonction de l'ID de Robot
Comme vous le voyez dans l'exemple ci-dessous, nous avons demandé les 3 premières tâches, mais seulement 1 a été renvoyée, car une seule tâche qui était exécutée sur le Robot avec l'ID 749 a été trouvée.
Obtenir
https://{yourDomain}/odata/Jobs?$top=3&$filter=Robot/Id eq 749
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 13,
"value": [
{
"Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
"StartTime": "2018-01-15T18:18:02.79Z",
"EndTime": "2018-01-15T18:18:47.587Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:18:01.623Z",
"StartingScheduleId": null,
"Id": 125161
},
{
"Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
"StartTime": "2018-03-02T17:25:35.17Z",
"EndTime": "2018-03-02T17:25:46.62Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
"Info": "Job completed",
"CreationTime": "2018-03-02T17:25:34.087Z",
"StartingScheduleId": null,
"Id": 127283
},
{
"Key": "e29e472d-5d51-4369-9c15-af867e6dd580",
"StartTime": "2018-03-05T18:27:27.123Z",
"EndTime": "2018-03-05T18:27:38.593Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "ad498d35-326c-4c6c-89d0-16fb73abd0c8",
"Info": "Execution error : System.ArgumentException: The sheet does not exist\r\n at UiPath.Excel.WorkbookApplication.SetSheet(String sheetName, Boolean createNew)\r\n at UiPath.Excel.Activities.ExcelInteropActivity`1.BeginExecute(AsyncCodeActivityContext context, AsyncCallback callback, Object state)\r\n at System.Activities.AsyncCodeActivity.InternalExecute(ActivityInstance instance, ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n at System.Activities.ActivityInstance.Execute(ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n at System.Activities.Runtime.ActivityExecutor.ExecuteActivityWorkItem.ExecuteBody(ActivityExecutor executor, BookmarkManager bookmarkManager, Location resultLocation)",
"CreationTime": "2018-03-05T18:27:25.793Z",
"StartingScheduleId": null,
"Id": 127416
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 13,
"value": [
{
"Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
"StartTime": "2018-01-15T18:18:02.79Z",
"EndTime": "2018-01-15T18:18:47.587Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:18:01.623Z",
"StartingScheduleId": null,
"Id": 125161
},
{
"Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
"StartTime": "2018-03-02T17:25:35.17Z",
"EndTime": "2018-03-02T17:25:46.62Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
"Info": "Job completed",
"CreationTime": "2018-03-02T17:25:34.087Z",
"StartingScheduleId": null,
"Id": 127283
},
{
"Key": "e29e472d-5d51-4369-9c15-af867e6dd580",
"StartTime": "2018-03-05T18:27:27.123Z",
"EndTime": "2018-03-05T18:27:38.593Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "ad498d35-326c-4c6c-89d0-16fb73abd0c8",
"Info": "Execution error : System.ArgumentException: The sheet does not exist\r\n at UiPath.Excel.WorkbookApplication.SetSheet(String sheetName, Boolean createNew)\r\n at UiPath.Excel.Activities.ExcelInteropActivity`1.BeginExecute(AsyncCodeActivityContext context, AsyncCallback callback, Object state)\r\n at System.Activities.AsyncCodeActivity.InternalExecute(ActivityInstance instance, ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n at System.Activities.ActivityInstance.Execute(ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n at System.Activities.Runtime.ActivityExecutor.ExecuteActivityWorkItem.ExecuteBody(ActivityExecutor executor, BookmarkManager bookmarkManager, Location resultLocation)",
"CreationTime": "2018-03-05T18:27:25.793Z",
"StartingScheduleId": null,
"Id": 127416
}
]
}
En fonction du nom de Robot
Cet appel demande toutes les 10 premières tâches qui ont été exécutées par un Robot avec le nom « DocBot », mais seulement 1 a été renvoyée, car une seule tâche a été trouvée.
Obtenir
https://{yourDomain}/odata/Jobs?$top=10&$filter=Robot/Name eq 'DocBot'
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 1,
"value": [
{
"Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
"StartTime": "2018-01-15T18:18:02.79Z",
"EndTime": "2018-01-15T18:18:47.587Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:18:01.623Z",
"StartingScheduleId": null,
"Id": 125161
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 1,
"value": [
{
"Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
"StartTime": "2018-01-15T18:18:02.79Z",
"EndTime": "2018-01-15T18:18:47.587Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:18:01.623Z",
"StartingScheduleId": null,
"Id": 125161
}
]
}
En fonction d'un ID de robot spécifique, avec un état spécifiques
L'exemple suivant recherche les 10 premières tâches qui ont été traitées par un Robot avec l'ID 749 et qui sont dans l'état Réussi. Comme vous le voyez, seuls deux résultats ont été renvoyés.
Obtenir
https://{yourDomain}/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and State eq 'Successful'
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "https://{yourDomain}/$metadata#Jobs",
"@odata.count": 2,
"value": [
{
"Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
"StartTime": "2018-01-15T18:18:02.79Z",
"EndTime": "2018-01-15T18:18:47.587Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:18:01.623Z",
"StartingScheduleId": null,
"Id": 125161
},
{
"Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
"StartTime": "2018-03-02T17:25:35.17Z",
"EndTime": "2018-03-02T17:25:46.62Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
"Info": "Job completed",
"CreationTime": "2018-03-02T17:25:34.087Z",
"StartingScheduleId": null,
"Id": 127283
}
]
}
{
"@odata.context": "https://{yourDomain}/$metadata#Jobs",
"@odata.count": 2,
"value": [
{
"Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
"StartTime": "2018-01-15T18:18:02.79Z",
"EndTime": "2018-01-15T18:18:47.587Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:18:01.623Z",
"StartingScheduleId": null,
"Id": 125161
},
{
"Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
"StartTime": "2018-03-02T17:25:35.17Z",
"EndTime": "2018-03-02T17:25:46.62Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
"Info": "Job completed",
"CreationTime": "2018-03-02T17:25:34.087Z",
"StartingScheduleId": null,
"Id": 127283
}
]
}
En fonction de l'ID de Robot et de la date de fin
L'exemple ci-dessous permet de rechercher les 10 premières tâches qui ont été exécutées par le Robot avec l'ID 759 et dont l'exécution a été terminée après le 22 février 2018, 10:00:00.837. Étant donné que trois tâches correspondaient à tous ces paramètres, seules celles-ci étaient renvoyées dans la section Réponse (Response).
Obtenir
https://{yourDomain}/odata/Jobs?$top=10&$filter=Robot/Id eq 759 and EndTime lt 2018-02-22T10:00:00.837Z
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 3,
"value": [
{
"Key": "45383b6c-a547-49e1-be5c-f3bb6d78982c",
"StartTime": "2018-01-15T18:17:14.693Z",
"EndTime": "2018-01-15T18:17:14.693Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "9eda64eb-3ab8-46e8-833d-fe944a4eb25e",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:17:13.59Z",
"StartingScheduleId": null,
"Id": 125160
},
{
"Key": "4b018719-36cb-43a1-8096-202641ccee62",
"StartTime": "2018-01-15T18:19:03.177Z",
"EndTime": "2018-01-15T18:19:03.177Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "7a60ce9d-a5a6-4e9f-b908-ab5819b016c2",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:19:02.37Z",
"StartingScheduleId": null,
"Id": 125162
},
{
"Key": "4420820e-7b0a-49a3-a172-ddcc1d88ace9",
"StartTime": "2018-01-15T18:20:07.93Z",
"EndTime": "2018-01-15T18:20:22.68Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "843d9f41-ae7b-4a28-bd32-d57006f90a2f",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:20:06.733Z",
"StartingScheduleId": null,
"Id": 125163
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 3,
"value": [
{
"Key": "45383b6c-a547-49e1-be5c-f3bb6d78982c",
"StartTime": "2018-01-15T18:17:14.693Z",
"EndTime": "2018-01-15T18:17:14.693Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "9eda64eb-3ab8-46e8-833d-fe944a4eb25e",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:17:13.59Z",
"StartingScheduleId": null,
"Id": 125160
},
{
"Key": "4b018719-36cb-43a1-8096-202641ccee62",
"StartTime": "2018-01-15T18:19:03.177Z",
"EndTime": "2018-01-15T18:19:03.177Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "7a60ce9d-a5a6-4e9f-b908-ab5819b016c2",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:19:02.37Z",
"StartingScheduleId": null,
"Id": 125162
},
{
"Key": "4420820e-7b0a-49a3-a172-ddcc1d88ace9",
"StartTime": "2018-01-15T18:20:07.93Z",
"EndTime": "2018-01-15T18:20:22.68Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "843d9f41-ae7b-4a28-bd32-d57006f90a2f",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:20:06.733Z",
"StartingScheduleId": null,
"Id": 125163
}
]
}
En fonction de la date de début et de l'ID de Robot
La requête suivante recherche les 10 premières tâches qui ont été exécutées par un Robot avec l'ID 749, à partir du 22 septembre 2017, 09:59:22.837.
Obtenir
https://{yourDomain}/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and State eq 'Successful'
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "https://{yourDomain}/$metadata#Jobs",
"@odata.count": 2,
"value": [
{
"Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
"StartTime": "2018-01-15T18:18:02.79Z",
"EndTime": "2018-01-15T18:18:47.587Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:18:01.623Z",
"StartingScheduleId": null,
"Id": 125161
},
{
"Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
"StartTime": "2018-03-02T17:25:35.17Z",
"EndTime": "2018-03-02T17:25:46.62Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
"Info": "Job completed",
"CreationTime": "2018-03-02T17:25:34.087Z",
"StartingScheduleId": null,
"Id": 127283
}
]
}
{
"@odata.context": "https://{yourDomain}/$metadata#Jobs",
"@odata.count": 2,
"value": [
{
"Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
"StartTime": "2018-01-15T18:18:02.79Z",
"EndTime": "2018-01-15T18:18:47.587Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
"Info": "Job completed",
"CreationTime": "2018-01-15T18:18:01.623Z",
"StartingScheduleId": null,
"Id": 125161
},
{
"Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
"StartTime": "2018-03-02T17:25:35.17Z",
"EndTime": "2018-03-02T17:25:46.62Z",
"State": "Successful",
"Source": "Manual",
"BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
"Info": "Job completed",
"CreationTime": "2018-03-02T17:25:34.087Z",
"StartingScheduleId": null,
"Id": 127283
}
]
}
Démarrage d'une tâche
linkLa requête suivante permet de démarrer l'exécution du processus indiqué (via le paramètre ReleaseKey), sur tous les Robots disponibles qui se trouvent dans l'environnement associé.
Publier
https://{yourDomain}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Corps de la requête
{
"startInfo": {
"ReleaseKey": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
"Strategy": "All",
"RobotIds": [],
"NoOfRobots": 0
}
}
{
"startInfo": {
"ReleaseKey": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
"Strategy": "All",
"RobotIds": [],
"NoOfRobots": 0
}
}
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"value": [
{
"Key": "31ade17f-5a35-4250-beea-43922dc2a20d",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"Source": "Manual",
"BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
"Info": null,
"CreationTime": "2018-03-19T19:01:58.6806126Z",
"StartingScheduleId": null,
"Id": 128209
},
{
"Key": "c4caf051-9db6-486d-8078-231f9dec1a4c",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"Source": "Manual",
"BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
"Info": null,
"CreationTime": "2018-03-19T19:01:58.7610094Z",
"StartingScheduleId": null,
"Id": 128210
},
{
"Key": "969552ba-cfe5-4e87-adde-c85a358ae96f",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"Source": "Manual",
"BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
"Info": null,
"CreationTime": "2018-03-19T19:01:58.8212679Z",
"StartingScheduleId": null,
"Id": 128211
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"value": [
{
"Key": "31ade17f-5a35-4250-beea-43922dc2a20d",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"Source": "Manual",
"BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
"Info": null,
"CreationTime": "2018-03-19T19:01:58.6806126Z",
"StartingScheduleId": null,
"Id": 128209
},
{
"Key": "c4caf051-9db6-486d-8078-231f9dec1a4c",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"Source": "Manual",
"BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
"Info": null,
"CreationTime": "2018-03-19T19:01:58.7610094Z",
"StartingScheduleId": null,
"Id": 128210
},
{
"Key": "969552ba-cfe5-4e87-adde-c85a358ae96f",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"Source": "Manual",
"BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
"Info": null,
"CreationTime": "2018-03-19T19:01:58.8212679Z",
"StartingScheduleId": null,
"Id": 128211
}
]
}
Démarrage d'une tâche avec des valeurs personnalisées pour les paramètres d'entrée
link/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
permet d'ajouter des valeurs personnalisées pour les paramètres d'entrée tout en démarrant également une tâche sur un Robot spécifique.
Notez qu'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.
0065
devient 53
.
Publier
https://{yourDomain}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Corps de la requête
{
"startInfo": {
"ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
"RobotIds": [121],
"JobsCount": 0,
"Strategy": "Specific",
"InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
}
}
{
"startInfo": {
"ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
"RobotIds": [121],
"JobsCount": 0,
"Strategy": "Specific",
"InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
}
}
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"value": [
{
"Key": "0fbdbecb-3677-4c33-a491-a1f7ed4ff886",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"Source": "Manual",
"SourceType": "Manual",
"BatchExecutionKey": "e188f409-c504-47b7-b2cf-30b8fe423f87",
"Info": null,
"CreationTime": "2018-08-27T16:41:00.4773869Z",
"StartingScheduleId": null,
"ReleaseName": "input_output_test_DocEnv",
"Type": "Unattended",
"InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}",
"OutputArguments": null,
"Id": 21767
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"value": [
{
"Key": "0fbdbecb-3677-4c33-a491-a1f7ed4ff886",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"Source": "Manual",
"SourceType": "Manual",
"BatchExecutionKey": "e188f409-c504-47b7-b2cf-30b8fe423f87",
"Info": null,
"CreationTime": "2018-08-27T16:41:00.4773869Z",
"StartingScheduleId": null,
"ReleaseName": "input_output_test_DocEnv",
"Type": "Unattended",
"InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}",
"OutputArguments": null,
"Id": 21767
}
]
}
Récupération des tâches qui ont été exécutées par un environnement indiqué
linkL'exemple suivant permet de récupérer les deux premières tâches qui ont été exécutées par des Robots qui font partie de l'environnement avec l'ID 312 et de développer les informations de processus.
Obtenir
https://{yourDomain}/odata/Jobs?$top=2&$expand=Release&$filter=Release/EnvironmentId eq 312
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 26,
"value": [
{
"Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
"StartTime": "2018-01-15T18:03:42.51Z",
"EndTime": "2018-01-15T18:03:44.353Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:03:41.56Z",
"StartingScheduleId": null,
"Id": 125153,
"Release": {
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "rockerii",
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": null,
"Id": 440
}
},
{
"Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
"StartTime": "2018-01-15T18:05:42.393Z",
"EndTime": "2018-01-15T18:05:42.393Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:05:41.093Z",
"StartingScheduleId": null,
"Id": 125154,
"Release": {
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "rockerii",
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": null,
"Id": 440
}
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 26,
"value": [
{
"Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
"StartTime": "2018-01-15T18:03:42.51Z",
"EndTime": "2018-01-15T18:03:44.353Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:03:41.56Z",
"StartingScheduleId": null,
"Id": 125153,
"Release": {
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "rockerii",
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": null,
"Id": 440
}
},
{
"Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
"StartTime": "2018-01-15T18:05:42.393Z",
"EndTime": "2018-01-15T18:05:42.393Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:05:41.093Z",
"StartingScheduleId": null,
"Id": 125154,
"Release": {
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "rockerii",
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": null,
"Id": 440
}
}
]
}
Récupération des tâches défaillantes en fonction des erreurs
linkL’appel ci-dessous vous aide à afficher les 2 premières tâches qui ont échoué avec l’erreur « Échec de la connexion : nom d’utilisateur inconnu ou mot de passe incorrect » et développe les détails du Robot et du processus. Vous pouvez utiliser cette requête pour tout type d'erreur affiché dans la fenêtre Détails de la tâche ( ob Details).
Obtenir
https://{yourDomain}/odata/Jobs?$filter=(CreationTime gt 2017-01-01T00:00:00.000Z and State eq '4' and indexof(Info,'Logon failure: unknown user
name or bad password') ne -1)&$expand=Robot,Release&$top=2
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 5,
"value": [
{
"Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
"StartTime": "2018-01-15T18:03:42.51Z",
"EndTime": "2018-01-15T18:03:44.353Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:03:41.56Z",
"StartingScheduleId": null,
"Id": 125153,
"Robot": {
"LicenseKey": null,
"MachineName": "DESKTOP-PMFQGCB",
"Name": "RoboDrulea",
"Username": "ALEX",
"Description": null,
"Type": "Unattended",
"Password": null,
"RobotEnvironments": "",
"Id": 758,
"ExecutionSettings": null
},
"Release": {
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": null,
"Id": 440
}
},
{
"Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
"StartTime": "2018-01-15T18:05:42.393Z",
"EndTime": "2018-01-15T18:05:42.393Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:05:41.093Z",
"StartingScheduleId": null,
"Id": 125154,
"Robot": {
"LicenseKey": null,
"MachineName": "DESKTOP-PMFQGCB",
"Name": "RoboDrulea",
"Username": "ALEX",
"Description": null,
"Type": "Unattended",
"Password": null,
"RobotEnvironments": "",
"Id": 758,
"ExecutionSettings": null
},
"Release": {
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": null,
"Id": 440
}
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
"@odata.count": 5,
"value": [
{
"Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
"StartTime": "2018-01-15T18:03:42.51Z",
"EndTime": "2018-01-15T18:03:44.353Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:03:41.56Z",
"StartingScheduleId": null,
"Id": 125153,
"Robot": {
"LicenseKey": null,
"MachineName": "DESKTOP-PMFQGCB",
"Name": "RoboDrulea",
"Username": "ALEX",
"Description": null,
"Type": "Unattended",
"Password": null,
"RobotEnvironments": "",
"Id": 758,
"ExecutionSettings": null
},
"Release": {
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": null,
"Id": 440
}
},
{
"Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
"StartTime": "2018-01-15T18:05:42.393Z",
"EndTime": "2018-01-15T18:05:42.393Z",
"State": "Faulted",
"Source": "Manual",
"BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
"Info": "Logon failure: unknown user name or bad password",
"CreationTime": "2018-01-15T18:05:41.093Z",
"StartingScheduleId": null,
"Id": 125154,
"Robot": {
"LicenseKey": null,
"MachineName": "DESKTOP-PMFQGCB",
"Name": "RoboDrulea",
"Username": "ALEX",
"Description": null,
"Type": "Unattended",
"Password": null,
"RobotEnvironments": "",
"Id": 758,
"ExecutionSettings": null
},
"Release": {
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": null,
"Id": 440
}
}
]
}
Arrêt de plusieurs tâches
linkLa requête ci-dessous nous permet d'arrêter (de force) deux tâches.
strategy
peut être renseigné avec les valeurs suivantes :
SoftStop
ou1
Kill
or2
.
Publier
https://{yourDomain}/odata/Jobs/UiPath.Server.Configuration.OData.StopJobs
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Corps de la requête
{
"jobIds": [22450719, 22450728],
"strategy": "1"
}
{
"jobIds": [22450719, 22450728],
"strategy": "1"
}
Codes de réponse
200 OK
Exportation des tâches
linkCette action nécessite des appels à différents points de terminaison.
Ce point de terminaison est limité à 100 requêtes d’API/jour/locataire.
- Lancez une exportation en appelant
POST
Ajoutez les filtres nécessaires.https://{yourDomain}/
/odata/Jobs/UiPath.Server.Configuration.OData.Export.Voici à quoi ressemble le corps de la requête :
POST https://{yourDomain}/odata/Jobs/UiPath.Server.Configuration.OData.Export?$top=1000&$expand=Robot,Machine,Release&$orderby=CreationTime%20desc HTTP/1.1 Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1 X-Uipath-Organizationunitid: 770643
POST https://{yourDomain}/odata/Jobs/UiPath.Server.Configuration.OData.Export?$top=1000&$expand=Robot,Machine,Release&$orderby=CreationTime%20desc HTTP/1.1 Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1 X-Uipath-Organizationunitid: 770643La réponse contient un ID nécessaire pour les étapes suivantes :
{"@odata.context":"https://{yourDomain}/odata/$metadata#Exports/$entity","Id":8661,"Name":"jobs-02c0398c-227b-47f4-aade-2252146d7d8f","Type":"Jobs","Status":"New","RequestedAt":"2024-01-15T07:48:34.8805788Z","ExecutedAt":null,"Size":null}
{"@odata.context":"https://{yourDomain}/odata/$metadata#Exports/$entity","Id":8661,"Name":"jobs-02c0398c-227b-47f4-aade-2252146d7d8f","Type":"Jobs","Status":"New","RequestedAt":"2024-01-15T07:48:34.8805788Z","ExecutedAt":null,"Size":null} - Obtenez le statut de la requête en appelant
GET https://{yourDomain}/orchestrator_/odata/Exports(8661)
, où le texte entre parenthèses est l’ID renvoyé à l’étape 1.Voici à quoi ressemble le corps de la requête :
GET https://{yourDomain}/odata/Exports(8661) HTTP/1.1 Host: alpha.uipath.com Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1 X-Uipath-Organizationunitid: 770643 Cookie: __cf_bm=lxqtVnB6oC_KS1nxJsWcqGK87Up9b5TGUCkZLeoaLP8-1705304914-1-AcpGG76FE03iiFdCw+u2Sq/xV3T38gqfvE7vjjZ5YHs5Iwjmrw1/1DjR5RSlqdQU1ocpukAZ1I0JLAGnkdOnumA=
GET https://{yourDomain}/odata/Exports(8661) HTTP/1.1 Host: alpha.uipath.com Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1 X-Uipath-Organizationunitid: 770643 Cookie: __cf_bm=lxqtVnB6oC_KS1nxJsWcqGK87Up9b5TGUCkZLeoaLP8-1705304914-1-AcpGG76FE03iiFdCw+u2Sq/xV3T38gqfvE7vjjZ5YHs5Iwjmrw1/1DjR5RSlqdQU1ocpukAZ1I0JLAGnkdOnumA=Attendez d’obtenir la réponse complète :
{"@odata.context":"https://{yourDomain}/odata/$metadata#Exports/$entity","Id":8661,"Name":"jobs-02c0398c-227b-47f4-aade-2252146d7d8f","Type":"Jobs","Status":"Completed","RequestedAt":"2024-01-15T07:48:34.88Z","ExecutedAt":"2024-01-15T07:48:38.51Z","Size":692}
{"@odata.context":"https://{yourDomain}/odata/$metadata#Exports/$entity","Id":8661,"Name":"jobs-02c0398c-227b-47f4-aade-2252146d7d8f","Type":"Jobs","Status":"Completed","RequestedAt":"2024-01-15T07:48:34.88Z","ExecutedAt":"2024-01-15T07:48:38.51Z","Size":692} - Obtenez le lien de téléchargement en appelant
GET https://{yourDomain}/odata/Exports(8661)/UiPath.Server.Configuration.OData.GetDownloadLink
, où le texte entre parenthèses est l’ID renvoyé à l’étape 1.Voici à quoi ressemble le corps de la requête :
GET https://{yourDomain}/odata/Exports(8661)/UiPath.Server.Configuration.OData.GetDownloadLink HTTP/1.1 Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1 X-Uipath-Organizationunitid: 770643
GET https://{yourDomain}/odata/Exports(8661)/UiPath.Server.Configuration.OData.GetDownloadLink HTTP/1.1 Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1 X-Uipath-Organizationunitid: 770643La réponse comprend un URI que vous pouvez utiliser pour récupérer une exportation CSV de vos données :
{"@odata.context":"https://{yourDomain}/odata/$metadata#UiPath.Server.Configuration.OData.BlobFileAccessDto","Uri":"<Download URI>","Verb":"GET","RequiresAuth":false,"Headers":{"Keys":[],"Values":[]}}
{"@odata.context":"https://{yourDomain}/odata/$metadata#UiPath.Server.Configuration.OData.BlobFileAccessDto","Uri":"<Download URI>","Verb":"GET","RequiresAuth":false,"Headers":{"Keys":[],"Values":[]}} - Envoyez une requête GET à l’URI qui a été renvoyé à l’étape 3. Cela déclenche le téléchargement de l’export CSV. Consultez la section Le rapport exporté dans notre guide de l’utilisateur pour en savoir plus sur le format et la convention d’affectation de noms.
- Demande de tâches démarrées par un Robot spécifique
- En fonction de l'ID de Robot
- En fonction du nom de Robot
- En fonction d'un ID de robot spécifique, avec un état spécifiques
- En fonction de l'ID de Robot et de la date de fin
- En fonction de la date de début et de l'ID de Robot
- Démarrage d'une tâche
- En-têtes de requête.
- Corps de la requête
- Codes de réponse
- Corps de la réponse
- Démarrage d'une tâche avec des valeurs personnalisées pour les paramètres d'entrée
- En-têtes de requête.
- Corps de la requête
- Codes de réponse
- Corps de la réponse
- Récupération des tâches qui ont été exécutées par un environnement indiqué
- En-têtes de requête.
- Codes de réponse
- Corps de la réponse
- Récupération des tâches défaillantes en fonction des erreurs
- En-têtes de requête.
- Codes de réponse
- Corps de la réponse
- Arrêt de plusieurs tâches
- En-têtes de requête.
- Corps de la requête
- Codes de réponse
- Exportation des tâches