Eine Liste von Vorgängen abrufen

Eine Liste aller aktiven oder abgeschlossenen Vorgänge kann verwendet werden, um:

Aktive Vorgänge zu verfolgen, die sich derzeit in der Phase der manuellen Überprüfung befinden.
Einen Link zur manuellen Überprüfung für aktive Vorgänge zu erhalten.
Die Ergebnisdateien abgeschlossener Vorgänge herunterzuladen.
Abgeschlossene Vorgänge in der Reihenfolge ihres Abschlusses abzuholen, ohne nachverfolgen zu müssen, welche Sie bereits abgeholt haben.

Sie können eine Liste von Vorgängen mit ihren Kennungen mithilfe der Vantage-API abrufen. Sie können den Skill Monitor verwenden, um erweiterte Filter anzuwenden.

Liste der aktiven Vorgänge

Um eine Liste der aktiven Vorgänge zu erhalten, senden Sie eine GET-Anfrage an die Ressource transactions/active. Geben Sie im Request-Body die folgenden Parameter an:

Parameter	Beschreibung
StageType	Die Phase des Vorgangs. Mögliche Werte sind: - ManuaReview - CustomActivity - Automatic (alle Phasen, in denen der Benutzer nicht erforderlich ist, zum Beispiel beim Extrahieren von Feldern)
StageName	Der Name der konkreten Aktion (nur für die Phase ManualReview).
SkillId	Die Skill-ID. Wenn kein Wert angegeben wird, werden alle verfügbaren Skills berücksichtigt.
SkillVersion	Die Skill-Version. Wenn kein Wert angegeben wird, werden alle Versionen der verfügbaren Skills berücksichtigt.
StartDate	Die Erstellungszeit des frühesten Vorgangs (muss im UTC-Format angegeben werden).
EndDate	Die Erstellungszeit des letzten Vorgangs (muss im UTC-Format angegeben werden). Wenn dieser Wert nicht angegeben wird, wird stattdessen die aktuelle UTC-Zeit verwendet.
TransactionParameters	Die Liste der Vorgangsparameter, bestehend aus Schlüssel-Wert-Paaren vom Typ string. Diese Parameter liefern zusätzliche Informationen über den Benutzer (zum Beispiel den Kundennamen). Parameter müssen im folgenden Format angegeben werden: `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	Die Liste der Dokumentparameter, bestehend aus Schlüssel-Wert-Paaren vom Typ string. Diese Parameter liefern zusätzliche Informationen zum Dokument (zum Beispiel den Dateinamen). Parameter müssen im folgenden Format angegeben werden: `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	Der Paginierungs-Offset. Der Standardwert des Parameters ist 0.
Limit	Das Paginierungslimit. Der Parameter ist erforderlich. Zulässige Werte: 1 bis 1000.

Beispielanforderung:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

Die Antwort auf eine Anfrage mit einer angegebenen Skill-ID wird eine JSON-Datei enthalten, die in etwa wie folgt aussieht:

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review",
      "seqId": 13758,
      "transactionId": "56a50415-fe1d-4493-81ba-97ff07e3ffce",
      "createTimeUtc": "2023-09-11T13:53:30.633Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "workspace.default.processing",
      "skillVersion": 18,
      "documentCount": 1
    }
  ],
  "totalItemCount": 7
}

Die Antwort auf eine Anfrage mit angegebener Phase und Aktion wird eine JSON-Datei mit allen aktiven Vorgängen enthalten, die in etwa wie folgt aussieht:

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review2",
      "seqId": 13852,
      "transactionId": "e646754e-d854-4b21-af91-58cb63ead7a6",
      "createTimeUtc": "2023-09-11T14:04:37.97Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 2
}

Sie können auch einen Link zum Manual-Review-Client für aktuell aktive Vorgänge abrufen. Senden Sie dazu eine GET-Anfrage an die Ressource transactions/<transaction_id> mit dem Vorgangsbezeichner in der Anforderungs-URI. Beispielanfrage:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

Die Antwort enthält in etwa folgenden Code:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-us.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-eu.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-au.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

Der Schlüssel manualReviewLink enthält einen Link zur Weboberfläche des Manual-Review-Clients sowie ein Vantage-Zugriffstoken, falls eine Manuelle Überprüfung erforderlich ist. Dieser Link und das Token können verwendet werden, um die Klassifizierungs- und Feldextraktionsergebnisse eines bestimmten Vorgangs zu überprüfen und zu korrigieren. Der bereitgestellte Link ist 168 Stunden lang gültig. Danach sollte ein neuer Link erstellt und für einen weiteren Zeitraum von 168 Stunden mit derselben Methode abgerufen werden. Weitere Informationen finden Sie unter Integration der manuellen Überprüfung.

Benutzer, die über diesen Link autorisiert wurden, können keine anderen Dokumente oder Vorgänge anzeigen oder ändern.

Liste der abgeschlossenen Vorgänge

Um eine Liste der abgeschlossenen Vorgänge abzurufen, senden Sie eine GET-Anfrage an die Ressource transactions/completed. Geben Sie im Request-Body die Parameter an:

Parameter	Beschreibung
TransactionStatus	Der Status des Vorgangs. Mögliche Werte sind: - Processed - Cancelled - Failed
SkillId	Die Skill-ID. Wenn kein Wert angegeben ist, werden alle verfügbaren Skills berücksichtigt.
SkillVersion	Die Skill-Version. Wenn kein Wert angegeben ist, werden alle Versionen der verfügbaren Skills berücksichtigt.
StartDate	Die Erstellungszeit des frühesten Vorgangs (muss im UTC-Format angegeben werden).
EndDate	Die Erstellungszeit des letzten Vorgangs (muss im UTC-Format angegeben werden). Wenn dieser Wert nicht angegeben ist, wird stattdessen die aktuelle UTC-Zeit verwendet.
TransactionParameters	Die Liste der Vorgangsparameter, bestehend aus Schlüssel-Wert-Paaren vom Typ string. Diese Parameter liefern zusätzliche Benutzerinformationen (z. B. den Kundennamen). Die Parameter müssen im folgenden Format angegeben werden: `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	Die Liste der Dokumentparameter, bestehend aus Schlüssel-Wert-Paaren vom Typ string. Diese Parameter liefern zusätzliche Dokumentinformationen (z. B. den Dateinamen). Die Parameter müssen im folgenden Format angegeben werden: `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	Der Paginierungs-Offset. Der Standardwert des Parameters ist 0.
Limit	Das Paginierungslimit. Der Parameter ist erforderlich. Akzeptierte Werte: 1 bis 1000.

Die Antwort enthält eine JSON-Datei mit allen abgeschlossenen Vorgängen und einer Anzahl verarbeiteter Seiten, ähnlich wie im folgenden Beispiel:

{
  "items": [
    {
      "status": "Processed",
      "pageCount": 1,
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "createTimeUtc": "2023-09-11T13:47:50.273Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 1,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "createTimeUtc": "2023-09-12T19:28:01.27Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "8391871e-abf5-41bc-8a66-1059418a3843",
      "createTimeUtc": "2023-09-13T08:53:41.9Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "7f7cd557-a03e-42e3-a454-e7981e8e9fc0",
      "createTimeUtc": "2023-09-13T09:35:27.48Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "c9b3cd4d-d90f-48be-adc2-99985ece4e11",
      "createTimeUtc": "2023-09-13T09:38:29.573Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}

Abholen abgeschlossener Vorgänge

Die Ressource transactions/completed gibt alle abgeschlossenen Vorgänge in einem Zeitraum zurück, sodass eine Integration, die Ergebnisse einsammelt, selbst nachhalten muss, welche Vorgänge sie bereits verarbeitet hat. Die Ressource transactions/pending-pickup erspart Ihnen diese Buchführung. Sie gibt abgeschlossene Vorgänge zurück, die Sie noch nicht gelöscht haben, und zwar in der Reihenfolge ihres Abschlusses; sobald Sie einen Vorgang löschen, verschwindet er aus der Liste. Eine typische Abholschleife sieht so aus:

Senden Sie eine GET-Anfrage an transactions/pending-pickup.
Laden Sie für jeden zurückgegebenen Vorgang die Ergebnisdateien herunter. Siehe Herunterladen von Quelldateien und Ergebnisdateien.
Löschen Sie den Vorgang mit einer DELETE-Anfrage an transactions/<transaction_id>. Damit wird er aus der Abholliste entfernt.
Enthält die Antwort einen nextCursor, wiederholen Sie den Ablauf ab Schritt 1 mit diesem Cursor, um die nächste Seite abzurufen. Ist nextCursor leer, haben Sie das Ende der Liste erreicht. Warten Sie Ihr Abfrageintervall ab und beginnen Sie erneut ohne Cursor.

Geben Sie in der Anfrage die folgenden Parameter an:

Parameter	Beschreibung
Limit	Die maximale Anzahl der Vorgänge, die auf einer Seite zurückgegeben werden. Zulässige Werte: 1 bis 1000.
Cursor	Der Wert `nextCursor` aus der vorherigen Antwort. Lassen Sie ihn weg, um beim ältesten abgeschlossenen und nicht gelöschten Vorgang zu beginnen. Behandeln Sie den Cursor als undurchsichtige Zeichenfolge.
Status	Der Status des Vorgangs. Mögliche Werte: - Processed - Cancelled - Failed Wird kein Wert angegeben, werden Vorgänge mit allen diesen Status zurückgegeben. Um nach mehreren Status zu filtern, trennen Sie die Werte durch Kommas.
SkillId	Die Skill-ID. Wird kein Wert angegeben, werden alle verfügbaren Skills berücksichtigt. Es werden Vorgänge aus jeder Version des Skills zurückgegeben.

Beispielanfrage:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

Die Antwort enthält die abgeschlossenen Vorgänge und einen Cursor für die nächste Seite:

{
  "items": [
    {
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "status": "Processed",
      "finishedTimeUtc": "2026-06-10T12:34:56Z"
    },
    {
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "status": "Failed",
      "finishedTimeUtc": "2026-06-10T12:35:02Z"
    }
  ],
  "nextCursor": "Q3Vyc29yRXhhbXBsZQ=="
}

Um die nächste Seite abzurufen, übergeben Sie den Cursor erneut in der Anfrage:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

Beachten Sie beim Erstellen einer Abruf-Integration Folgendes:

Die Zustellung erfolgt mindestens einmal. Jeder abgeschlossene Vorgang erscheint mindestens einmal; unter bestimmten Umständen – etwa in den wenigen Minuten zwischen einem DELETE-Anfrage und der tatsächlichen Entfernung – kann dieselbe transactionId jedoch mehrfach auftreten. Speichern Sie die bereits verarbeiteten Bezeichner und überspringen Sie alle, die erneut auftauchen.
Holen Sie Ergebnisse ab, bevor sie ablaufen. Ein Vorgang bleibt nur so lange in der Abholliste, wie seine Daten in Vantage aufbewahrt werden. Wird der Vorgang durch die Datenaufbewahrungsrichtlinie entfernt, bevor Sie ihn abgeholt haben, erscheint er nicht mehr in der Liste. Historische Datensätze bleiben über die Reporting-API verfügbar.
Berechtigungen. Der Request gibt nur Vorgänge für diejenigen Skills zurück, auf die der authentifizierte Benutzer Zugriffsberechtigung hat – genauso wie bei transactions/completed.
Abfrageintervall. Die Abholliste wird ausschließlich per Pull bereitgestellt. Fragen Sie sie nicht kontinuierlich ab, sondern in einem Intervall, das dazu passt, wie schnell Sie Ergebnisse benötigen. Allgemeine Hinweise finden Sie unter Polling.

Overview

Developer Guide

Eine Liste von Vorgängen abrufen

Liste der aktiven Vorgänge

Liste der abgeschlossenen Vorgänge

Abholen abgeschlossener Vorgänge

​Liste der aktiven Vorgänge

​Liste der abgeschlossenen Vorgänge

​Abholen abgeschlossener Vorgänge

Liste der aktiven Vorgänge

Liste der abgeschlossenen Vorgänge

Abholen abgeschlossener Vorgänge