Anforderungen von Warteschlangenelementen

Wichtig:

/QueueItems-Endpunkte zählen und geben das DTO für jede Wiederholung eines Warteschlangenelements in allen Ordnern zurück, mit denen die Warteschlange verknüpft ist. Wenn Sie beispielsweise ein (1) Warteschlangenelement für eine Warteschlange haben, die mit drei (3) Ordnern verknüpft ist, beträgt die Anzahl und Menge der zurückgegebenen Warteschlangenelemente drei (1x3).

Um die Ergebnisse für einen bestimmten Ordner abzurufen, verwenden Sie den X-UiPath-OrganizationUnitId-Header.

Löschen Sie den Wert SpecificContent aus einem Warteschlangenelement

Mit der folgenden PUT-Anforderung an den /odata/QueueItems({key}) -Endpunkt können Sie den spezifischen Inhalt des angegebenen Warteschlangenelements löschen, das durch {key}identifiziert wird.

Wichtig:

Sie können jetzt den spezifischen Inhalt von Warteschlangenelementen mit dem Status Erfolgreich, Gelöscht oder Wiederholt löschen.

API-Endpunkt

PUT https://{yourDomain}/odata/QueueItems({Id})

Um den spezifischen Inhalt zu löschen, müssen Sie den entsprechenden Wert auf NULL oder leer festlegen, während alle anderen Werte in der Nutzlast mit denen im Status „Erfolgreich“ übereinstimmen. Das heißt, Sie löschen nur den Inhalt, während alle anderen Anforderungsparameter gleich bleiben.

Um die Werte für die PUT-Anforderungsparameter herauszufinden, stellen Sie eine GET-Anforderung an/odata/QueueItems. Die Antwort zeigt alle Warteschlangenelemente in Ihrem Mandanten an.

Identifizieren Sie das Warteschlangenelement, an dem Sie interessiert sind, und kopieren Sie die Werte der folgenden Parameter:

• „OrganizationUnitId“ die ID des Ordners, der das Warteschlangenelement enthält
• „Id“ die ID des Warteschlangenelements. Stellen Sie sicher, dass Sie das Warteschlangenelement mit dem Status Erfolgreich auswählen.

Stellen Sie eine zweite GET-Anforderung an /odata/QueueItems({Id})und ersetzen Sie {Id} durch die Warteschlangenelement-ID, die Sie aus dem vorherigen GET-Aufruf kopiert haben. Die Antwort zeigt die Daten des gewünschten Warteschlangenelements an. Kopieren Sie die Werte der folgenden Parameter:

• „Name“ ersetzt {the_Name_from_the_GET_response} in der Beispielanforderung

• „Priority“ zum Ersetzen von {the_Priority_from_the_GET_response} in der Beispielanforderung

• „DeferDate“ zum Ersetzen von {the_DeferDate_from_the_GET_response} in der Beispielanforderung

• „DueDate“ zum Ersetzen von {the_DueDate_from_the_GET_response} in der Beispielanforderung

• „RiskSlaDate“ ersetzt {the_RiskSlaDate_from_the_GET_response} in der Beispielanforderung

• „Reference“ zum Ersetzen von {the_Reference_from_the_GET_response} in der Beispielanforderung

• „Progress“ zum Ersetzen von {the_Progress_from_the_GET_response} in der Beispielanforderung

  Hinweis:

  Sie verwenden die oben genannten Parameterwerte, um den Text der PUT-Anforderung auszufüllen.

Anforderungsheader

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json' \
--header 'X-UIPATH-OrganizationUnitId: {the_ID_of_the_folder_that_contains_the_queue_item}' \

Pfadparameter

Parameter	Datentyp	Beschreibung
Id (erforderlich)	String	Die ID des Warteschlangenelements, aus dem Sie den bestimmten Inhalt löschen möchten.

Anforderungstext

Der Anforderungstext enthält die Informationen zum Warteschlangenelement, die Sie aktualisieren möchten, z. B. Name, Priorität oder Referenz.

Hinweis:

Für diesen Anwendungsfall müssen Sie AUSSCHLIESSLICH den Wert für den Schlüssel „SpecificContent“ aktualisieren.

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

Beispielanforderung

Angenommen, Sie haben alle Informationen gesammelt, die zum Erstellen des API-Aufrufs erforderlich sind.

Warteschlangenelementwerte OrganizationUnitId und Id abrufen

Um die Ordner- und Warteschlangenelement-IDs zu ermitteln, stellen Sie eine GET-Anforderung an den Endpunkt /odata/QueueItems :

curl --location --request GET '{OrchestratorURL}/odata/QueueItems' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \

Ein Beispiel für die Antwort, die Sie möglicherweise erhalten:

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

Identifizieren Sie das erfolgreiche Warteschlangenelement und kopieren Sie die folgenden Werte:

• "OrganizationUnitId" : 39419
• "Id": 2499339

Abrufen der gewünschten Warteschlangenelementdaten

Stellen Sie eine GET-Anforderung an den Endpunkt /odata/QueueItems({Id}) :

• Ersetzen Sie {Id} durch den Wert der zuvor gefundenen ID (z. B. 2499339).

• Verwenden Sie den X-UIPATH-OrganizationUnitId -Anforderungsheader und geben Sie den Wert der zuvor gefundenen OrganizationUnitId ein (z. B. 39419).

  curl --location --request GET '{OrchestratorURL}/odata/QueueItems(2499339)' \
  --header 'Authorization: Bearer 1234' \
  --header 'Content-Type: application/json' \
  --header 'X-UIPATH-OrganizationUnitId: 39419'
  

  Ein Beispiel für die Antwort, die Sie möglicherweise erhalten:

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

Kopieren Sie die folgenden Werte:

• "Priority" : "High"
• "DeferDate" : null
• "DueDate" : null
• "RiskSlaDate": "2022-02-17T13:27:43.895Z"
• "Reference" : "82086"
• "Progress" : null

Den SpecificContent-Wert löschen

Stellen Sie die PUT-Anforderung wie folgt:

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

Hinweis:

Beachten Sie, dass sich nur der SpecificContent-Parameter ändert, indem er einen NULL oder einen leeren Wert annimmt, während die übrigen Werte mit den Werten aus der GET-Antwort übereinstimmen.

In der Orchestrator-Benutzeroberfläche ist die Änderung in den Transaktions-Details der entsprechenden Transaktions-ID sichtbar.

Abbildung 1. Transaktionsdetails