Vai al contenuto principale

​
Ottenere un elenco di transaction

Un elenco di tutte le transaction attive o completate può essere utilizzato per:
  • Tenere traccia delle transaction attive attualmente nella fase di revisione manuale.
  • Ottenere un link di revisione manuale per le transaction attive.
  • Scaricare i file dei risultati delle transaction completate.
Puoi ottenere un elenco di transaction con i relativi identificatori utilizzando la Vantage API. Puoi usare Skill Monitor per applicare filtri più avanzati.

​
Elenco delle transazioni attive

Per ottenere un elenco delle transazioni attive, invia una richiesta GET alla risorsa transactions/active. Nel corpo della richiesta, specifica i seguenti parametri:
ParameterDescription
StageTypeLa fase della transaction.
I valori possibili sono:
- ManualReview
- CustomActivity
- Automatic (tutte le fasi in cui non è richiesto l’intervento dell’utente, ad esempio l’estrazione dei field)
StageNameIl nome dell’azione specifica (solo per la fase ManualReview).
SkillIdL’identificatore della Skill.
Se non viene specificato alcun valore, verranno considerate tutte le Skill disponibili.
SkillVersionLa versione della Skill.
Se non viene specificato alcun valore, verranno considerate tutte le versioni delle Skill disponibili.
StartDateL’ora di creazione della transaction meno recente (deve essere specificata in formato UTC).
EndDateL’ora di creazione della transaction più recente (deve essere specificata in formato UTC).
Se questo valore non è specificato, verrà utilizzata l’ora UTC corrente.
TransactionParametersL’elenco dei parametri della transaction costituito da coppie chiave-valore di tipo string. Questi parametri forniscono informazioni aggiuntive sull’utente (ad esempio, il nome del cliente).
I parametri devono essere forniti nel seguente formato: TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}
DocumentParametersL’elenco dei parametri del documento costituito da coppie chiave-valore di tipo string. Questi parametri forniscono informazioni aggiuntive sul documento (ad esempio, il nome file).
I parametri devono essere forniti nel seguente formato: DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
OffsetL’offset di paginazione.
Il valore predefinito del parametro è 0.
LimitIl limite di paginazione. Il parametro è obbligatorio.
Il valore predefinito del parametro è 0.
Esempio di richiesta (Windows): 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"
Disponibile anche in altre regioni: 
# Nord America
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"

# Australia
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"
Esempio di richiesta (Linux): 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
Disponibile anche in altre regioni: 
# Nord America
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'

# Australia
curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
La risposta a una richiesta con uno specifico identificatore di skill conterrà un file JSON simile al seguente: 
{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Revisione",
      "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
}
La risposta a una richiesta con uno stage e un’azione specificati conterrà un file JSON con tutte le transaction attive, simile al seguente: 
{
  "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
}
È anche possibile ottenere un link del client di revisione manuale per le transaction attualmente attive. Per farlo, inviare una richiesta GET alla risorsa transactions/<transaction_id> con l’identificatore della transaction nell’URI della richiesta. Esempio di richiesta (Windows): 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
Disponibile anche in altre regioni: 
# Nord America
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

# Australia
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
Esempio di richiesta (Linux): 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'
Disponibile anche in altre regioni: 
# Nord America
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'

# Australia
curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'
La risposta conterrà codice simile al seguente: 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "In elaborazione",
  "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 elaborazione",
  "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"
    }
  ]
}
La chiave manualReviewLink conterrà un link all’interfaccia web del client di revisione manuale e un token di accesso a Vantage, se è richiesta la revisione manuale. Questo link e token possono essere utilizzati per rivedere e correggere la classificazione e i risultati di estrazione dei field di una specifica transaction. Il link fornito è valido per 168 ore, trascorse le quali è necessario creare e ottenere un nuovo link per un ulteriore periodo di 168 ore utilizzando lo stesso metodo. Per ulteriori informazioni, vedere Integrazione della revisione manuale.
Gli utenti autorizzati tramite questo link non potranno visualizzare o modificare altri documenti o transaction.

​
Elenco delle transaction completate

Per ottenere un elenco delle transaction completate, inviare una richiesta GET alla risorsa transactions/completed. Nel corpo della richiesta, specificare i parametri:
ParameterDescription
TransactionStatusLo stato della transaction.
I valori possibili sono:
- Processed
- Canceled
- Failed
SkillIdL’identificatore della Skill.
Se non viene specificato alcun valore, verranno considerate tutte le Skill disponibili.
SkillVersionLa versione della Skill.
Se non viene specificato alcun valore, verranno considerate tutte le versioni delle Skill disponibili.
StartDateL’orario di creazione della transaction meno recente (deve essere specificato in formato UTC).
EndDateL’orario di creazione della transaction più recente (deve essere specificato in formato UTC).
Se questo valore non è specificato, verrà utilizzato l’orario UTC corrente.
TransactionParametersL’elenco dei parametri della transaction costituito da coppie chiave-valore di tipo string. Questi parametri forniscono informazioni utente aggiuntive (ad esempio, il nome del cliente).
I parametri devono essere forniti nel seguente formato: TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}
DocumentParametersL’elenco dei parametri del documento costituito da coppie chiave-valore di tipo string. Questi parametri forniscono informazioni aggiuntive sul documento (ad esempio, il nome del file).
I parametri devono essere forniti nel seguente formato: DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
OffsetL’offset di paginazione.
Il valore predefinito del parametro è 0.
LimitIl limite di paginazione. Il parametro è obbligatorio.
Il valore predefinito del parametro è 0.
La risposta conterrà un file JSON con tutte le transaction completate e il numero di pagine elaborate, simile al seguente: 
{
  "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
}