Demandes d'éléments de la file d'attente

Important :

Les points de terminaison /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).

Pour récupérer les résultats d'un dossier spécifique, utilisez l'en-tête X-UiPath-OrganizationUnitId.

Supprimer la valeur SpecificContent d'un élément de la file d'attente

La requête PUT suivante au point de terminaison /odata/QueueItems({key}) vous permet de supprimer le contenu spécifique de l'élément de file d'attente spécifié, identifiable par {key}.

Important : vous pouvez désormais supprimer le contenu spécifique des éléments de la file d'attente avec les statuts Réussi ( Successful),Supprimé(Deleted) ou Nouvelle tentative ( Retryed) .

Point de terminaison de l’API

PUT https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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.

Pour savoir quelles sont les valeurs des paramètres de la requête PUT, envoyez une requête GET à/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).

Envoyez une deuxième requête GET à /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ête
  Remarque : vous utilisez les valeurs de paramètre ci-dessus pour remplir le corps de la demande PUT.

En-têtes de requête.

--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ètres de chemin d'accès

Param	Type de données	Description
Id (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.

Corps de la requête

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.

Remarque : pour ce cas d'utilisation, vous devez mettre à jour UNIQUEMENT la valeur de la clé 'SpecificContent'.

{
      "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
}

Exemple de requête

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

Pour connaître les ID des éléments de dossier et de file d'attente, envoyez une requête GET au point de terminaison /odata/QueueItems :

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
    }
  ]
}

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

Envoyez une requête GET au point de terminaison /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'

  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
  }

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
}'

Remarque : Notez que le paramètre 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.

Exportation des éléments de la file d’attente

Cette action nécessite des appels à différents points de terminaison.

Remarque :

Ce point de terminaison est limité à 100 requêtes d’API/jour/locataire.

1. Lancez une exportation en appelant POST https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_//odata/QueueDefinitions. Ajoutez les filtres nécessaires.

   Voici à quoi ressemble le corps de la requête :

   POST https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/QueueDefinitions(27965)/UiPathODataSvc.Export?$filter=((QueueDefinitionId%20eq%2027965))&$expand=Robot,ReviewerUser HTTP/1.1
   
   Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1
   X-Uipath-Organizationunitid: 770643
   Content-Length: 0

   La réponse contient un ID nécessaire pour les étapes suivantes :

   {"@odata.context":"https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Exports/$entity","Id":8657,"Name":"MyQueue12345-items","Type":"Queues","Status":"New","RequestedAt":"2024-01-15T07:38:21.8891311Z","ExecutedAt":null,"Size":null}

2. Obtenez le statut de la requête en appelant GET https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/orchestrator_/odata/Exports(8657), 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}/{organizationName}/{tenantName}/orchestrator_/odata/Exports(8657) HTTP/1.1
   Host: alpha.uipath.com
   Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1
   X-Uipath-Organizationunitid: 770643
   Cookie: __cf_bm=SGYN6zxyBJpmMFjIxBCC8M2eZUvxXaEFqCiZtbidn00-1705304301-1-AUAOuQBjBD1bJQZXFHnyqzGZuBIyHkMpmedMwLZLMtRuGgsyCAsyTOaM8qVoi1meJ0/lRNX6BUZUfV7fWYZc43E=

   Attendez d’obtenir la réponse complète :

   {"@odata.context":"https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Exports/$entity","Id":8657,"Name":"MyQueue12345-items","Type":"Queues","Status":"Completed","RequestedAt":"2024-01-15T07:37:02.783Z","ExecutedAt":"2024-01-15T07:37:05.553Z","Size":203226}

3. Obtenez le lien de téléchargement en appelant GET https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Exports(8657)/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}/{organizationName}/{tenantName}/orchestrator_/odata/Exports(8657)/UiPath.Server.Configuration.OData.GetDownloadLink HTTP/1.1
   Host: alpha.uipath.com
   Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1
   X-Uipath-Organizationunitid: 770643
   Cookie: __cf_bm=SGYN6zxyBJpmMFjIxBCC8M2eZUvxXaEFqCiZtbidn00-1705304301-1-AUAOuQBjBD1bJQZXFHnyqzGZuBIyHkMpmedMwLZLMtRuGgsyCAsyTOaM8qVoi1meJ0/lRNX6BUZUfV7fWYZc43E=

   La réponse comprend un URI que vous pouvez utiliser pour récupérer une exportation CSV de vos données :

   {"@odata.context":"https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Server.Configuration.OData.BlobFileAccessDto","Uri":"<Download URI>","Verb":"GET","RequiresAuth":false,"Headers":{"Keys":[],"Values":[]}}

4. 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.