Transaktionsanfragen

Hinweis: Warteschlangenobjekte können nur von Robotern verarbeitet werden. Zum Beispiel erfordert eine POST-Abfrage an den Endpunkt /odata/Queues/UiPathODataSvc.StartTransaction Informationen, die nur dem Roboter zur Verfügung stehen.

Anzeigen des Objektverlaufs

Die folgende Abfrage ermöglicht Ihnen, alle Aktionen anzuzeigen, die ein bestimmtes Warteschlangenobjekt durchlaufen hat.

Abrufen

{OrchestratorURL}/odata/QueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId=1050203)?$orderby=Timestamp&$top=10

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#QueueItemEvents",
    "@odata.count": 5,
    "value": [
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-07T16:02:59.09Z",
            "Action": "Create",
            "Data": null,
            "UserId": 910,
            "UserName": "DocBot",
            "Status": "New",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "ReviewerUserName": null,
            "Id": 18276
        },
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-07T18:15:04.46Z",
            "Action": "Status",
            "Data": null,
            "UserId": 910,
            "UserName": "DocBot",
            "Status": "InProgress",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "ReviewerUserName": null,
            "Id": 20333
        },
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-07T18:15:05.07Z",
            "Action": "Edit",
            "Data": null,
            "UserId": 910,
            "UserName": "DocBot",
            "Status": "InProgress",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "ReviewerUserName": null,
            "Id": 20334
        },
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-07T18:15:05.507Z",
            "Action": "Edit",
            "Data": null,
            "UserId": 910,
            "UserName": "DocBot",
            "Status": "Failed",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "ReviewerUserName": null,
            "Id": 20335
        },
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-08T10:47:40.463Z",
            "Action": "Edit",
            "Data": null,
            "UserId": 583,
            "UserName": "admin",
            "Status": "Failed",
            "ReviewStatus": "None",
            "ReviewerUserId": 583,
            "ReviewerUserName": "admin",
            "Id": 21240
        }
    ]
}

Abfragen der mittleren Ausführungszeit für eine bestimmten Warteschlange

Mit der folgenden Abfrage können Sie die mittlere Ausführungszeit der Objekte in einer angegebenen Warteschlange anzeigen.

Hinweis: Diese Art von Abfrage lässt sich nur nach dem Namen oder der Beschreibung der Warteschlange und nicht nach der Warteschlangen-ID filtern.

Abrufen

{OrchestratorURL}/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus?$filter=QueueDefinitionName eq 'DocQueue'

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Core.Model.Queues.QueueProcessingStatus)",
    "@odata.count": 1,
    "value": [
        {
            "ItemsToProcess": 682,
            "ItemsInProgress": 0,
            "QueueDefinitionId": 188,
            "QueueDefinitionName": "DocQueue",
            "QueueDefinitionDescription": null,
            "QueueDefinitionAcceptAutomaticallyRetry": true,
            "QueueDefinitionMaxNumberOfRetries": 5,
            "QueueDefinitionEnforceUniqueReference": false,
            "ProcessingMeanTime": 2.15,
            "SuccessfulTransactionsNo": 0,
            "ApplicationExceptionsNo": 0,
            "BusinessExceptionsNo": 883,
            "SuccessfulTransactionsProcessingTime": 0,
            "ApplicationExceptionsProcessingTime": 0,
            "BusinessExceptionsProcessingTime": 2.15,
            "TotalNumberOfTransactions": 883,
            "LastProcessed": "2018-03-07T18:20:29.3833333Z"
        }
    ]
}

Ändern des Prüfers eines Warteschlangenobjekts

Im folgenden Beispiel können Sie den Prüfer des fehlgeschlagenen Transaktionsobjekts mit der ID 1050200 ändern.

Hinweis: Der Wert des Parameters RowVersion ändert sich immer, wenn das Warteschlangenobjekt aktualisiert wird. Um diese Informationen abzurufen, müssen Sie einen GET-Abruf für den Endpunkt /odata/QueueItems() durchführen, zum Beispiel {OrchestratorURL}/odata/QueueItems(1050200).

Posten

{OrchestratorURL}/odata/QueueItems/UiPathODataSvc.SetItemReviewer

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
    "queueItems": [{
        "Id": 1050200, 
        "RowVersion":"AAAAAABDIK8="
    }], 
    "userId": 583
}

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfInt64",
    "Success": true,
    "Message": null,
    "FailedItems": []
}

Abrufen von Warteschlangenobjekten mit einem angegebenen Überprüfungsstatus

Mit diesem Beispiel können Sie die ersten beiden Warteschlangenobjekte extrahieren, deren Revisionsstatus auf „Wird überprüft“ festgelegt ist..

Abrufen

{OrchestratorURL}/odata/QueueItems?$filter=ReviewStatus eq 'InReview'&$top=2

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#QueueItems",
    "@odata.count": 3,
    "value": [
        {
            "QueueDefinitionId": 188,
            "OutputData": null,
            "Status": "Failed",
            "ReviewStatus": "InReview",
            "ReviewerUserId": 583,
            "Key": "e4760d27-a76d-4469-b7e6-fbda2f732b10",
            "Reference": "ActivityDescription",
            "ProcessingExceptionType": "BusinessException",
            "DueDate": null,
            "Priority": "High",
            "DeferDate": null,
            "StartProcessing": "2018-03-07T18:14:56.633Z",
            "EndProcessing": "2018-03-07T18:14:58.723Z",
            "SecondsInPreviousAttempts": 2,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Description\":\"Gets a specified credential by using a provided AssetName, and returns a username and a secure password.\"}}",
            "CreationTime": "2018-03-07T16:02:57.547Z",
            "Progress": null,
            "RowVersion": "AAAAAABDFiU=",
            "Id": 1050199,
            "ProcessingException": {
                "Reason": "because I say so",
                "Details": null,
                "Type": "BusinessException",
                "AssociatedImageFilePath": null,
                "CreationTime": "2018-03-07T18:14:58.723Z"
            },
            "SpecificContent": {
                "Description": "Gets a specified credential by using a provided AssetName, and returns a username and a secure password."
            },
            "Output": null
        },
        {
            "QueueDefinitionId": 188,
            "OutputData": null,
            "Status": "Failed",
            "ReviewStatus": "InReview",
            "ReviewerUserId": 583,
            "Key": "e90e8067-50fc-407a-9678-eede311f815a",
            "Reference": "ActivityDescription",
            "ProcessingExceptionType": "BusinessException",
            "DueDate": null,
            "Priority": "High",
            "DeferDate": null,
            "StartProcessing": "2018-03-07T18:14:54.85Z",
            "EndProcessing": "2018-03-07T18:14:57.103Z",
            "SecondsInPreviousAttempts": 2,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Description\":\"Gets a specified asset by using a provided AssetName. If the asset is not global, it must be assigned to the local robot in order to be retrieved.\"}}",
            "CreationTime": "2018-03-07T16:02:57.287Z",
            "Progress": null,
            "RowVersion": "AAAAAABDFiY=",
            "Id": 1050198,
            "ProcessingException": {
                "Reason": "because I say so",
                "Details": null,
                "Type": "BusinessException",
                "AssociatedImageFilePath": null,
                "CreationTime": "2018-03-07T18:14:57.103Z"
            },
            "SpecificContent": {
                "Description": "Gets a specified asset by using a provided AssetName. If the asset is not global, it must be assigned to the local robot in order to be retrieved."
            },
            "Output": null
        }
    ]
}

Warteschlangenobjekt hinzufügen

Das nachstehende Beispiel ermöglicht uns, ein Objekt zur Warteschlange „DocQueue“ mit hoher Priorität, Verschiebungs- und Fälligkeitsdaten und zwei Argumente mit Werten hinzuzufügen. Alle auf diese Weise hinzugefügten Objekte haben den Status Neu, genau wie die Aktivität „Warteschlangenobjekt hinzufügen“.

Bitte beachten Sie, dass der Parameter SpecificContent nur mit primären Werten gefüllt werden darf.

Posten

{OrchestratorURL}/odata/Queues/UiPathODataSvc.AddQueueItem

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
    "itemData": {
        "Priority": "High",
        "DeferDate": "2018-03-21T13:42:27.654Z",
        "DueDate": "2018-03-25T13:42:27.654Z",
        "Name": "DocQueue",
        "SpecificContent": {
            "Email": "[e-mail]", 
            "Name": "O'Brian"
        }
    }
}

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#queueItem/$entity",
    "QueueDefinitionId": 188,
    "OutputData": null,
    "Status": "New",
    "ReviewStatus": "None",
    "ReviewerUserId": null,
    "Key": "e9cb2205-0232-4b99-9556-52dc2e686663",
    "Reference": null,
    "ProcessingExceptionType": null,
    "DueDate": "2018-03-25T13:42:27.654Z",
    "Priority": "High",
    "DeferDate": "2018-03-21T13:42:27.654Z",
    "StartProcessing": null,
    "EndProcessing": null,
    "SecondsInPreviousAttempts": 0,
    "AncestorId": null,
    "RetryNumber": 0,
    "SpecificData": "{\"DynamicProperties\":{\"Email\":\"[e-mail]\",\"Name\":\"O'brian\"}}",
    "CreationTime": "2018-03-21T15:31:27.2699068Z",
    "Progress": null,
    "RowVersion": "AAAAAABDGLk=",
    "Id": 1050947,
    "ProcessingException": null,
    "SpecificContent": {
        "Email": "[e-mail]",
        "Name": "O'Brian"
    },
    "Output": null
}}

Hinzufügen mehrerer Warteschlangenelemente

Wichtig:

Wenn Sie mehreren Ordnern zugewiesen sind, muss Ihre Anforderung einen HTTP-Header enthalten, der entweder den FolderId oder den FolderPath der gewünschten Warteschlange bereitstellt. Weitere Informationen finden Sie hier .

Wenn sie nicht enthalten ist, schlägt die Anforderung mit dem folgenden Fehler fehl: An organization unit is required for this action.

In den folgenden Beispielen können wir mehrere Elemente gleichzeitig zur Warteschlange „DocTest“ hinzufügen, die so konfiguriert wurde, dass nur eindeutige Referenzen zulässig sind. Sobald die Elemente hinzugefügt wurden, haben sie alle den Status Neu .

Es wird empfohlen, den Datentyp für den Inhalt „Spezifische Daten“ anzugeben. Wenn das Feld Name beispielsweise Daten vom Typ String enthält, sollten Sie ein zusätzliches Schlüssel:Wert-Paar mit der folgenden Syntax "[e-mail]": "#string"hinzufügen. Siehe die Beispiele unten.

Das erste Beispiel ist erfolgreich, während das letztere fehlschlägt, da den Elementen Referenzen fehlen, die für Warteschlangen mit eindeutigen Referenzen erforderlich sind.

Es gibt zwei Upload-Strategien, die Sie beim Hinzufügen mehrerer Warteschlangenelemente verwenden können:

• AllOrNothing – Fügt Warteschlangenelemente nur hinzu, wenn kein Fehler auftritt. Andernfalls wird nichts eingefügt und die Zeile zurückgegeben, in der der Fehler aufgetreten ist.
• ProcessAllIndependently – Fügt alle Ihre Elemente hinzu und gibt eine Liste aller Elemente zurück, die fehlgeschlagen sind.
  Hinweis:

  Fehlgeschlagene Anforderungen geben 200 OK zurück, da die fehlgeschlagenen Elemente im Textkörper der Antwort zurückgegeben werden, wie Sie im zweiten Beispiel sehen können.

  Die einzigen Anforderungen, die 200 OK nicht zurückgeben, sind diejenigen, bei denen die Eingabeparameter falsch sind.

Erfolgreiche Anforderung

Posten

{OrchestratorURL}/odata/Queues/UiPathODataSvc.BulkAddQueueItems

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
    "queueName": "DocTest",
    "commitType": "AllOrNothing",
    "queueItems": [{
            "Priority": "High",
            "SpecificContent": {
                "Name": "rêvé",
                "[e-mail]": "#String"
            },
            "DeferDate": "2019-03-14T12:20:13.290Z",
            "DueDate": "2019-03-14T12:20:13.290Z",
            "Reference": "ref4"
        },
        {
            "Priority": "High",
            "SpecificContent": {
                "Name": "même",
                "[e-mail]": "#String"
            },
            "DeferDate": "2019-03-14T12:20:13.290Z",
            "DueDate": "2019-03-14T12:20:13.290Z",
            "Reference": "ref5"
        },
        {
            "Priority": "High",
            "SpecificContent": {
                "Name": "Žao",
                "[e-mail]": "#String"
            },
            "DeferDate": "2019-03-14T12:20:13.290Z",
            "DueDate": "2019-03-14T12:20:13.290Z",
            "Reference": "ref6"
        }
    ]
}

Antwortcode

200 OK

Antworttext

{
  "@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfFailedQueueItemDto",
  "Success": true,
  "Message": null,
  "FailedItems": []
}

Anforderung fehlgeschlagen

Posten

{OrchestratorURL}/odata/Queues/UiPathODataSvc.BulkAddQueueItems

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
    "queueName": "DocTest",
    "commitType": "AllOrNothing",
    "queueItems": [{
            "Priority": "High",
            "SpecificContent": {
                "Name": "rêvé",
                "[e-mail]": "#String"
            },
            "DeferDate": "2019-03-14T12:20:13.290Z",
            "DueDate": "2019-03-14T12:20:13.290Z",
        },
        {
            "Priority": "High",
            "SpecificContent": {
                "Name": "même",
                "[e-mail]": "#String"
            },
            "DeferDate": "2019-03-14T12:20:13.290Z",
            "DueDate": "2019-03-14T12:20:13.290Z",
        },
        {
            "Priority": "High",
            "SpecificContent": {
                "Name": "Žao",
                "[e-mail]": "#String"
            },
            "DeferDate": "2019-03-14T12:20:13.290Z",
            "DueDate": "2019-03-14T12:20:13.290Z",
        }
    ]
}

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfFailedQueueItemDto",
    "Success": false,
    "Message": "Some items have not been inserted.",
    "FailedItems": [{
        "Ordinal": 1,
        "ErrorCode": "TransactionReferenceRequired",
        "ErrorMessage": "Error creating Transaction. Reference is required for Unique Reference Queues."
    }]
}

Abrufen von Transaktionen nach Status und Roboter-ID

Im folgenden Beispiel wird die Orchestrator-Datenbank nach den ersten 10 Warteschlangenobjekten mit dem Status In Bearbeitung abgefragt, die von dem Roboter mit der ID 749 bearbeitet wurden. Zuletzt werden die Roboterinformationen erweitert. Bitte beachten Sie, dass die Antwort abgeschnitten wurde.

Abrufen

{OrchestratorURL}//odata/QueueItems?$top=10&$expand=Robot&$filter=Status eq 'InProgress' and Robot/Id eq 749

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#QueueItems",
    "@odata.count": 1752,
    "value": [
        {
            "QueueDefinitionId": 188,
            "OutputData": null,
            "Status": "InProgress",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "Key": "1c632cc1-44ab-4624-bace-6fbb5fd1c0cd",
            "Reference": "ActivityDescription",
            "ProcessingExceptionType": null,
            "DueDate": null,
            "Priority": "High",
            "DeferDate": null,
            "StartProcessing": "2018-03-07T15:05:05.113Z",
            "EndProcessing": null,
            "SecondsInPreviousAttempts": 0,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Description\":\"Checks if Stop was triggered in UiPath Orchestrator.\"}}",
            "CreationTime": "2018-03-05T18:39:16.06Z",
            "Progress": null,
            "RowVersion": "AAAAAABC3aA=",
            "Id": 1048065,
            "ProcessingException": null,
            "SpecificContent": {
                "Description": "Checks if Stop was triggered in UiPath Orchestrator."
            },
            "Output": null,
            "Robot": {
                "LicenseKey": null,
                "MachineName": "MBOBOC",
                "Name": "DocBot",
                "Username": "UIPATH\\MADALINA.BOBOC",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "",
                "Id": 749,
                "ExecutionSettings": null
            }
        },
        {
            "QueueDefinitionId": 188,
            "OutputData": null,
            "Status": "InProgress",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "Key": "7dfa834b-8398-476e-bd18-b0fa51d4ddf6",
            "Reference": "ActivityDescription",
            "ProcessingExceptionType": null,
            "DueDate": null,
            "Priority": "High",
            "DeferDate": null,
            "StartProcessing": "2018-03-07T15:05:04.503Z",
            "EndProcessing": null,
            "SecondsInPreviousAttempts": 0,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Description\":\"Sets the status of a transaction item to Failed or Successful.\"}}",
            "CreationTime": "2018-03-05T18:39:15.627Z",
            "Progress": null,
            "RowVersion": "AAAAAABC3Z8=",
            "Id": 1048064,
            "ProcessingException": null,
            "SpecificContent": {
                "Description": "Sets the status of a transaction item to Failed or Successful."
            },
            "Output": null,
            "Robot": {
                "LicenseKey": null,
                "MachineName": "MBOBOC",
                "Name": "DocBot",
                "Username": "UIPATH\\MADALINA.BOBOC",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "",
                "Id": 749,
                "ExecutionSettings": null
            }
        }
    ]
}

Abrufen von Kommentaren für ein bestimmtes Objekt

Im nachstehenden Beispiel werden die Anmerkungen des Warteschlangenobjekts mit der ID 1050204 in aufsteigender Reihenfolge der Erstellung angezeigt.

Abrufen

{OrchestratorURL}/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=1050204)?$orderby=CreationTime%20desc

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#QueueItemComments",
    "@odata.count": 2,
    "value": [
        {
            "Text": "needs review asap",
            "QueueItemId": 1050204,
            "CreationTime": "2018-03-08T13:41:49.167Z",
            "UserId": 583,
            "UserName": "admin",
            "Id": 320
        },
        {
            "Text": "fixed. excel hiccup.",
            "QueueItemId": 1050204,
            "CreationTime": "2018-03-08T13:46:48.613Z",
            "UserId": 901,
            "UserName": "dragomirmir",
            "Id": 321
        }
    ]
}