- Démarrage
- 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 génériques
- 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 d'espaces de travail personnels
- Requêtes relatives aux processus
- Demandes d'éléments de la file d'attente
- 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 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
Demandes d'éléments de la file d'attente
/QueueItems
comptent et renvoient le DTO pour chaque récurrence d'un élément de file d'attente dans tous les dossiers auxquels la file d'attente est liée. Par exemple, si vous avez un (1) élément pour une file d'attente liée à trois (3) dossiers, le nombre d'éléments de file d'attente renvoyés est de trois (1x3).
X-UiPath-OrganizationUnitId
.
/odata/QueueItems({key})
vous permet de supprimer le contenu spécifique de l'élément de file d'attente spécifié, identifiable par {key}
.
https://{yourDomain}/odata/QueueItems({Id})
Pour supprimer le contenu spécifique, vous devez définir la valeur correspondante sur NULL ou vide, tandis que toutes les autres valeurs de la charge utile correspondent à celles dans l'état réussi. C'est-à-dire que vous supprimez uniquement le contenu, tandis que tous les autres paramètres de requête restent les mêmes.
/odata/QueueItems
. La réponse affiche tous les éléments de file d'attente de votre locataire.
Identifiez l'élément de file d'attente qui vous intéresse et copiez les valeurs des paramètres suivants :
- "OrganizationUnitId" l'ID du dossier qui contient l'élément de file d'attente
-
« ID » l'ID de l'élément de la file d'attente. Assurez-vous de sélectionner l'élément de file d'attente avec un statut Réussi (Successful).
/odata/QueueItems({Id})
et remplacez {Id}
par l'ID d'élément de file d'attente que vous avez copié à partir de l'appel GET précédent. La réponse affiche les données de l'élément de file d'attente souhaité. Copiez les valeurs des paramètres suivants :
- « Nom » pour remplacer
{the_Name_from_the_GET_response}
dans l’exemple de requête - « Priorité » pour remplacer
{the_Priority_from_the_GET_response}
dans l'exemple de requête - « DeferDate » pour remplacer
{the_DeferDate_from_the_GET_response}
dans l'exemple de requête - « DueDate » pour remplacer
{the_DueDate_from_the_GET_response}
dans l'exemple de requête - "RiskSlaDate" pour remplacer
{the_RiskSlaDate_from_the_GET_response}
dans l'exemple de requête - « Référence » pour remplacer
{the_Reference_from_the_GET_response}
dans l'exemple de requête -
« Priorité » pour remplacer
{the_Progress_from_the_GET_response}
dans l'exemple de requêteRemarque : vous utilisez les valeurs de paramètre ci-dessus pour remplir le corps de la demande PUT.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json' \
--header 'X-UIPATH-OrganizationUnitId: {the_ID_of_the_folder_that_contains_the_queue_item}' \
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json' \
--header 'X-UIPATH-OrganizationUnitId: {the_ID_of_the_folder_that_contains_the_queue_item}' \
Param |
Type de données |
Description |
---|---|---|
(requis) |
Chaîne de caractères (string) |
L'ID de l'élément de file d'attente dont vous souhaitez supprimer le contenu spécifique. |
Le corps de la demande contient les informations de l'élément de file d'attente que vous souhaitez mettre à jour, telles que le nom, la priorité ou la référence.
{
"Name": "{queue_name}", // String, the_name_of_the_container_queue
"Priority": "{the_Priority_from_the_GET_response}",//String
"SpecificContent": {}, // or NULL
"DeferDate": "{the_DeferDate_from_the_GET_response}", // 2022-02-17T13:27:43.895Z
"DueDate": "{the_DueDate_from_the_GET_response}", // 2022-02-17T13:27:43.895Z
"RiskSlaDate": "{the_RiskSlaDate_from_the_GET_response}", // 2022-02-17T13:27:43.895Z
"Reference": "{the_Reference_from_the_GET_response}", // String
"Progress": "{the_Progress_from_the_GET_response}" // String
}
{
"Name": "{queue_name}", // String, the_name_of_the_container_queue
"Priority": "{the_Priority_from_the_GET_response}",//String
"SpecificContent": {}, // or NULL
"DeferDate": "{the_DeferDate_from_the_GET_response}", // 2022-02-17T13:27:43.895Z
"DueDate": "{the_DueDate_from_the_GET_response}", // 2022-02-17T13:27:43.895Z
"RiskSlaDate": "{the_RiskSlaDate_from_the_GET_response}", // 2022-02-17T13:27:43.895Z
"Reference": "{the_Reference_from_the_GET_response}", // String
"Progress": "{the_Progress_from_the_GET_response}" // String
}
Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.
Obtenir les valeurs de l'élément de file d'attente OrganizationUnitId
et Id
/odata/QueueItems
:
curl --location --request GET '{OrchestratorURL}/odata/QueueItems' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
curl --location --request GET '{OrchestratorURL}/odata/QueueItems' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
Exemple de réponse que vous pourriez recevoir :
{
"value": [
{
"QueueDefinitionId": 29200,
"OutputData": "{\"DynamicProperties\":{\"Prop1\":\"run\"}}",
"AnalyticsData": null,
"Status": "New",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "bc4e8fac-dc4b-4f77-8f20-13590e19ff26",
"Reference": null,
"ProcessingExceptionType": null,
"DueDate": null,
"RiskSlaDate": null,
"Priority": "Normal",
"DeferDate": null,
"StartProcessing": "2022-02-16T15:30:12.13Z",
"EndProcessing": "2022-02-16T15:30:12.46Z",
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Prop2\":\"accelerate\"}}",
"CreationTime": "2022-02-16T15:30:11.753Z",
"Progress": null,
"RowVersion": "AAAAAAB2liA=",
"OrganizationUnitId": 62516,
"OrganizationUnitFullyQualifiedName": "Banana",
"Id": 3255808,
"ProcessingException": null,
"SpecificContent": {
"Prop2": "Test demo"
},
"Output": {
"Prop1": "vgdfdf"
},
"Analytics": null
},
// other queue items data
{
"QueueDefinitionId": 3899,
"OutputData": null,
"AnalyticsData": null,
"Status": "Successful",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "6ea50a9c-b657-4df3-bfe6-d1893c4f31ec",
"Reference": "82086",
"ProcessingExceptionType": null,
"DueDate": null,
"RiskSlaDate": "2022-02-17T13:27:43.895Z",
"Priority": "High",
"DeferDate": null,
"StartProcessing": null,
"EndProcessing": null,
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"EmployeeName\":\"John Kensington\",\"ContactNumber\":\"+4457899\",\"RelocationDistance\":500,\"Description\":\"Home relocation\",\"ExpenseCode\":\"UI234\",\"Amount\":1000,\"RequirePass\":true}}",
"CreationTime": "2021-03-19T17:37:35.893Z",
"Progress": null,
"RowVersion": "AAAAAABQET4=",
"OrganizationUnitId": 39419,
"OrganizationUnitFullyQualifiedName": "Shared",
"Id": 2499339,
"ProcessingException": null,
"SpecificContent": {
"EmployeeName": "John Kensington",
"ContactNumber": "+4457899",
"RelocationDistance": 500,
"Description": "Home relocation",
"ExpenseCode": "UI234",
"Amount": 1000,
"RequirePass": true
},
"Output": null,
"Analytics": null
}
]
}
{
"value": [
{
"QueueDefinitionId": 29200,
"OutputData": "{\"DynamicProperties\":{\"Prop1\":\"run\"}}",
"AnalyticsData": null,
"Status": "New",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "bc4e8fac-dc4b-4f77-8f20-13590e19ff26",
"Reference": null,
"ProcessingExceptionType": null,
"DueDate": null,
"RiskSlaDate": null,
"Priority": "Normal",
"DeferDate": null,
"StartProcessing": "2022-02-16T15:30:12.13Z",
"EndProcessing": "2022-02-16T15:30:12.46Z",
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"Prop2\":\"accelerate\"}}",
"CreationTime": "2022-02-16T15:30:11.753Z",
"Progress": null,
"RowVersion": "AAAAAAB2liA=",
"OrganizationUnitId": 62516,
"OrganizationUnitFullyQualifiedName": "Banana",
"Id": 3255808,
"ProcessingException": null,
"SpecificContent": {
"Prop2": "Test demo"
},
"Output": {
"Prop1": "vgdfdf"
},
"Analytics": null
},
// other queue items data
{
"QueueDefinitionId": 3899,
"OutputData": null,
"AnalyticsData": null,
"Status": "Successful",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "6ea50a9c-b657-4df3-bfe6-d1893c4f31ec",
"Reference": "82086",
"ProcessingExceptionType": null,
"DueDate": null,
"RiskSlaDate": "2022-02-17T13:27:43.895Z",
"Priority": "High",
"DeferDate": null,
"StartProcessing": null,
"EndProcessing": null,
"SecondsInPreviousAttempts": 0,
"AncestorId": null,
"RetryNumber": 0,
"SpecificData": "{\"DynamicProperties\":{\"EmployeeName\":\"John Kensington\",\"ContactNumber\":\"+4457899\",\"RelocationDistance\":500,\"Description\":\"Home relocation\",\"ExpenseCode\":\"UI234\",\"Amount\":1000,\"RequirePass\":true}}",
"CreationTime": "2021-03-19T17:37:35.893Z",
"Progress": null,
"RowVersion": "AAAAAABQET4=",
"OrganizationUnitId": 39419,
"OrganizationUnitFullyQualifiedName": "Shared",
"Id": 2499339,
"ProcessingException": null,
"SpecificContent": {
"EmployeeName": "John Kensington",
"ContactNumber": "+4457899",
"RelocationDistance": 500,
"Description": "Home relocation",
"ExpenseCode": "UI234",
"Amount": 1000,
"RequirePass": true
},
"Output": null,
"Analytics": null
}
]
}
Identifiez l'élément File d'attente réussie et copiez les valeurs suivantes :
- "OrganizationUnitId" : 39419
- "Id": 2499339
Obtenir les données d'élément de file d'attente souhaitées
/odata/QueueItems({Id})
:
- Remplacez {Id} par la valeur de l'ID précédemment trouvé (c'est-à-dire 2499339)
-
Utilisez l'en-tête de requête
X-UIPATH-OrganizationUnitId
et saisissez la valeur de l'IDOrganisationUnit (OrganizationUnitId) précédemment trouvé (c'est-à-dire 39419).curl --location --request GET '{OrchestratorURL}/odata/QueueItems(2499339)' \ --header 'Authorization: Bearer 1234' \ --header 'Content-Type: application/json' \ --header 'X-UIPATH-OrganizationUnitId: 39419'
curl --location --request GET '{OrchestratorURL}/odata/QueueItems(2499339)' \ --header 'Authorization: Bearer 1234' \ --header 'Content-Type: application/json' \ --header 'X-UIPATH-OrganizationUnitId: 39419'Exemple de réponse que vous pourriez recevoir :
{ "QueueDefinitionId": 3899, "OutputData": null, "AnalyticsData": null, "Status": "Successful", "ReviewStatus": "None", "ReviewerUserId": null, "Key": "6ea50a9c-b657-4df3-bfe6-d1893c4f31ec", "Reference": "82086", "ProcessingExceptionType": null, "DueDate": null, "RiskSlaDate": "2022-02-17T13:27:43.895Z", "Priority": "High", "DeferDate": null, "StartProcessing": null, "EndProcessing": null, "SecondsInPreviousAttempts": 0, "AncestorId": null, "RetryNumber": 0, "SpecificData": "{\"DynamicProperties\":{\"EmployeeName\":\"John Kensington\",\"ContactNumber\":\"+4457899\",\"RelocationDistance\":500,\"Description\":\"Home relocation\",\"ExpenseCode\":\"UI234\",\"Amount\":1000,\"RequirePass\":true}}", "CreationTime": "2021-03-19T17:37:35.893Z", "Progress": null, "RowVersion": "AAAAAABQET4=", "OrganizationUnitId": 39419, "OrganizationUnitFullyQualifiedName": null, "Id": 2499339, "ProcessingException": null, "SpecificContent": { "EmployeeName": "John Kensington", "ContactNumber": "+4457899", "RelocationDistance": 500, "Description": "Home relocation", "ExpenseCode": "UI234", "Amount": 1000, "RequirePass": true }, "Output": null, "Analytics": null }
{ "QueueDefinitionId": 3899, "OutputData": null, "AnalyticsData": null, "Status": "Successful", "ReviewStatus": "None", "ReviewerUserId": null, "Key": "6ea50a9c-b657-4df3-bfe6-d1893c4f31ec", "Reference": "82086", "ProcessingExceptionType": null, "DueDate": null, "RiskSlaDate": "2022-02-17T13:27:43.895Z", "Priority": "High", "DeferDate": null, "StartProcessing": null, "EndProcessing": null, "SecondsInPreviousAttempts": 0, "AncestorId": null, "RetryNumber": 0, "SpecificData": "{\"DynamicProperties\":{\"EmployeeName\":\"John Kensington\",\"ContactNumber\":\"+4457899\",\"RelocationDistance\":500,\"Description\":\"Home relocation\",\"ExpenseCode\":\"UI234\",\"Amount\":1000,\"RequirePass\":true}}", "CreationTime": "2021-03-19T17:37:35.893Z", "Progress": null, "RowVersion": "AAAAAABQET4=", "OrganizationUnitId": 39419, "OrganizationUnitFullyQualifiedName": null, "Id": 2499339, "ProcessingException": null, "SpecificContent": { "EmployeeName": "John Kensington", "ContactNumber": "+4457899", "RelocationDistance": 500, "Description": "Home relocation", "ExpenseCode": "UI234", "Amount": 1000, "RequirePass": true }, "Output": null, "Analytics": null }
Copiez les valeurs suivantes :
- "Priority" : "High"
- "DeferDate" : null
- "DueDate" : null
- "RiskSlaDate": "2022-02-17T13:27:43.895Z"
- "Reference" : "82086"
- "Progress" : null
Supprimer la valeur SpecificContent
Effectuez la requête PUT comme suit :
curl --location --request PUT '{OrchestratorURL}/odata/QueueItems(2499339)' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-OrganizationUnitId: 39419'\
--data-raw '{
"Name": " Queue Demo",
"Priority": "High",
"SpecificContent": {},
"DeferDate": null,
"DueDate": null,
"RiskSlaDate": "2022-02-17T13:27:43.895Z",
"Reference": "82086",
"Progress": null
}'
curl --location --request PUT '{OrchestratorURL}/odata/QueueItems(2499339)' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-OrganizationUnitId: 39419'\
--data-raw '{
"Name": " Queue Demo",
"Priority": "High",
"SpecificContent": {},
"DeferDate": null,
"DueDate": null,
"RiskSlaDate": "2022-02-17T13:27:43.895Z",
"Reference": "82086",
"Progress": null
}'
SpecificContent
est le seul qui change, en ayant une valeur NULL ou vide, tandis que le reste des valeurs correspond aux valeurs de la réponse GET.
Dans l'interface utilisateur d'Orchestrator, la modification est visible dans les détails de la transaction de l'ID de transaction correspondant.