Zum Hauptinhalt springen

​
Abrufen einer Liste von Vorgängen

Eine Liste aller aktiven oder abgeschlossenen Vorgänge kann verwendet werden, um:
  • Aktive Vorgänge nachzuverfolgen, die sich derzeit in der Manuellen Überprüfung befinden.
  • Einen Link zur Manuellen Überprüfung für aktive Vorgänge zu erhalten.
  • Die Ergebnisdateien abgeschlossener Vorgänge herunterzuladen.
Sie können eine Liste von Vorgängen mit ihren IDs über die Vantage-API abrufen. Für erweiterte Filter können Sie den Skill Monitor verwenden.

​
Liste aktiver Vorgänge

Um eine Liste aktiver Vorgänge zu erhalten, senden Sie eine GET-Anfrage an die Ressource transactions/active. Geben Sie im Anfragetext die folgenden Parameter an:
ParameterBeschreibung
StageTypeDie Phase des Vorgangs.
Mögliche Werte sind:
- ManualReview
- CustomActivity
- Automatic (alle Phasen, in denen kein Benutzer erforderlich ist, z. B. die Felderkennung)
StageNameDer Name der konkreten Aktion (nur für die Phase ManualReview).
SkillIdDie Skill-Kennung.
Wenn kein Wert angegeben ist, werden alle verfügbaren Skills berücksichtigt.
SkillVersionDie Skill-Version.
Wenn kein Wert angegeben ist, werden alle Versionen der verfügbaren Skills berücksichtigt.
StartDateDie Erstellungszeit des frühesten Vorgangs (muss im UTC-Format angegeben werden).
EndDateDie Erstellungszeit des neuesten Vorgangs (muss im UTC-Format angegeben werden).
Wenn dieser Wert nicht angegeben ist, wird stattdessen die aktuelle UTC-Zeit verwendet.
TransactionParametersDie Liste der Vorgangsparameter, bestehend aus Schlüssel-Wert-Paaren vom Typ string. Diese Parameter liefern zusätzliche Benutzerinformationen (z. B. den Kundennamen).
Parameter müssen in folgendem Format angegeben werden: TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}
DocumentParametersDie Liste der Dokumentparameter, bestehend aus Schlüssel-Wert-Paaren vom Typ string. Diese Parameter liefern zusätzliche Dokumentinformationen (z. B. den Dateinamen).
Parameter müssen in folgendem Format angegeben werden: DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
OffsetDer Paginierungsversatz.
Der Standardwert des Parameters ist 0.
LimitDas Paginierungslimit. Der Parameter ist erforderlich.
Der Standardwert des Parameters ist 0.
Beispielanfrage (Windows): 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"
Auch in anderen Regionen verfügbar: 
# Nordamerika
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"

# Australien
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"
Beispielanfrage (Linux): 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
Auch in anderen Regionen verfügbar: 
# Nordamerika
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'

# Australien
curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
Die Antwort auf eine Anfrage mit einer bestimmten Skill-Kennung enthält eine JSON-Datei ähnlich der folgenden: 
{
  "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 einer angegebenen Phase und Aktion enthält eine JSON-Datei mit allen aktiven Vorgängen, ähnlich dem folgenden: 
{
  "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 (Windows): 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
Auch in anderen Regionen verfügbar: 
# Nordamerika
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

# Australien
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
Beispielanfrage (Linux): 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'
Auch in anderen Regionen verfügbar: 
# Nordamerika
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'

# Australien
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-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-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": "In Bearbeitung",
  "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 und ein Vantage-Zugriffstoken, sofern eine manuelle Überprüfung erforderlich ist. Mit diesem Link und dem Token können die Klassifizierungs- und Feldauszugsergebnisse eines bestimmten Vorgangs überprüft und korrigiert werden. Der bereitgestellte Link ist 168 Stunden gültig; danach sollte mit derselben Methode ein neuer Link für weitere 168 Stunden erstellt und abgerufen werden. Weitere Informationen finden Sie unter Integration der manuellen Überprüfung.
Über diesen Link autorisierte Benutzer können keine anderen Dokumente oder Vorgänge anzeigen oder ändern.

​
Liste der abgeschlossenen Vorgänge

Um eine Liste der abgeschlossenen Vorgänge zu erhalten, senden Sie eine GET-Anfrage an die Ressource transactions/completed. Geben Sie im Anforderungstext die Parameter an:
ParameterBeschreibung
TransactionStatusDer Status des Vorgangs.
Mögliche Werte sind:
- Processed
- Canceled
- Failed
SkillIdDie Skill-ID.
Wenn kein Wert angegeben ist, werden alle verfügbaren Skills berücksichtigt.
SkillVersionDie Skill-Version.
Wenn kein Wert angegeben ist, werden alle Versionen der verfügbaren Skills berücksichtigt.
StartDateDer Erstellungszeitpunkt des frühesten Vorgangs (muss im UTC-Format angegeben werden).
EndDateDer Erstellungszeitpunkt des neuesten Vorgangs (muss im UTC-Format angegeben werden).
Wenn dieser Wert nicht angegeben ist, wird stattdessen die aktuelle UTC-Zeit verwendet.
TransactionParametersDie Liste der Vorgangsparameter, bestehend aus Schlüssel-Wert-Paaren vom Typ string. Diese Parameter liefern zusätzliche Benutzerinformationen (zum Beispiel den Kundennamen).
Parameter müssen im folgenden Format angegeben werden: TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}
DocumentParametersDie Liste der Dokumentparameter, bestehend aus Schlüssel-Wert-Paaren vom Typ string. Diese Parameter liefern zusätzliche Dokumentinformationen (zum Beispiel den Dateinamen).
Parameter müssen im folgenden Format angegeben werden: DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
OffsetDer Paginierungsversatz.
Der Standardwert des Parameters ist 0.
LimitDas Paginierungslimit. Der Parameter ist erforderlich.
Der Standardwert des Parameters ist 0.
Die Antwort enthält eine JSON-Datei mit allen abgeschlossenen Vorgängen und der Anzahl verarbeiteter Seiten, ähnlich der folgenden: 
{
  "items": [
    {
      "status": "FinishedSuccessfully",
      "pageCount": 1,
      "seqId": 13705,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 29842,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36254,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36632,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36663,
      "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"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}