Getting a list of transactions
A list of all active or completed transactions can be used to:
- Track active transactions currently at the Manual Review stage.
- Obtain a manual review link for active transactions.
- Download the result files of completed transactions.
You can get a list of transactions with their identifiers using the Vantage API. You can use#ERROR_INVALID_LINK_?topic=skillmonitor');#to apply more advanced filters.
List of active transactions
To get a list of active transactions, send aGETrequest to thetransactions/activeresource as follows:
|
POST https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active for users in Western Europe, POST https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active for users in North America and POST https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active for users in Australia |
In the request body, specify the following parameters:
| Parameter | Description |
|---|---|
| StageType |
The stage of the transaction. The possible values are:
|
| StageName | The name of the specific action (only for the ManualReview stage). |
| SkillId |
The skill identifier. If no value is specified, all available skills will be taken into account. |
| SkillVersion |
The skill version. If no value is specified, all versions of available skills will be taken into account. |
| StartDate | The creation time of the earliest transaction (must be specified in UTC format). |
| EndDate |
The creation time of the latest transaction (must be specified in UTC format). If this value is not specified, the current UTC time will be used instead. |
| TransactionParameters |
The list of transaction parameters consisting of key-value string pairs. These parameters provide additional user information (for example, the client name). Parameters must be provided in the following format:TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”} |
| DocumentParameters |
The list of document parameters consisting of key-value string pairs. These parameters provide additional document information (for example, the file name). Parameters must be provided in the following format: DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”} |
| Offset |
The pagination offset. The default value of the parameter is0. |
| Limit |
The pagination limit. The parameter is required. The default value of the parameter is0. |
Sample request:
For Windows
For Linux
The response to a request with a specified skill identifier will contain a JSON file similar to the following:
Response for a specified skill with a Limit=1
The response to a request with a specified stage and action will contain a JSON file with all active transactions similar to the following:
Response for a specified stage and action with a Limit=1
You can also obtain a Manual Review client link for currently active transactions. To do so, send a GET request to the transactions/<transaction_id> resource with the transaction identifier in the request URI as follows:
GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id for users in Western Europe, GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id for users in North America and GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id for users in Australia |
Sample request:
For Windows
For Linux
The response will contain code similar to the following:
Response
The manualReviewLink key will contain a link to the web interface of the Manual Review client and a Vantage access token, if manual review is required. This link and token can be used to review and correct the classification and field extraction results of a particular transaction. The provided link is valid for 168 hours, after which a new link should be created and obtained for another period of 168 hours using the same method. For more information, seeIntegrating manual review.
Users authorized via this link will not be able to view or modify any other documents or transactions.
List of completed transactions
To get a list of completed transactions, send aGETrequest to thetransactions/completedresource as follows:
|
POST https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/completed for users in Western Europe, POST https://vantage-us.abbyy.com/api/publicapi/v1/transactions/completed for users in North America and POST https://vantage-au.abbyy.com/api/publicapi/v1/transactions/completed for users in Australia |
In the request body, specify the parameters:
| Parameter | Description |
|---|---|
| TransactionStatus |
The status of the transaction. The possible values are:
|
| SkillId |
The skill identifier. If no value is specified, all available skills will be taken into account. |
| SkillVersion |
The skill version. If no value is specified, all versions of available skills will be taken into account. |
| StartDate | The creation time of the earliest transaction (must be specified in UTC format). |
| EndDate |
The creation time of the latest transaction (must be specified in UTC format). If this value is not specified, the current UTC time will be used instead. |
| TransactionParameters |
The list of transaction parameters consisting of key-value string pairs. These parameters provide additional user information (for example, the client name). Parameters must be provided in the following format:TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”} |
| DocumentParameters |
The list of document parameters consisting of key-value string pairs. These parameters provide additional document information (for example, the file name). Parameters must be provided in the following format: DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”} |
| Offset |
The pagination offset. The default value of the parameter is0. |
| Limit |
The pagination limit. The parameter is required. The default value of the parameter is0. |
The response will contain a JSON file with all completed transactions and a number of processed pages similar to the following:
Response
12/22/2023 12:36:42 PM