Vai al contenuto principale
GET
/
api
/
publicapi
/
v1
/
transactions
/
active
Restituisce le transazioni attive con i Parameter specificati
curl --request GET \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "<string>",
      "reviewerEmail": "<string>",
      "reviewerName": "<string>",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createTimeUtc": "2023-11-07T05:31:56Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "skillId": "<string>",
      "skillVersion": 123,
      "documentCount": 123
    }
  ],
  "totalItemCount": 123
}

Autorizzazioni

Authorization
string
header
obbligatorio

The access token received from the authorization server in the OAuth 2.0 flow.

Parametri della query

StageType
string

Stato attuale della transaction Fase corrente della transaction

StageName
string

Nome attuale della fase della transaction Nome della fase corrente della transaction

SkillId
string

ID della skill disponibile (in base alle autorizzazioni). Se questo campo è vuoto, tutte le skill disponibili verranno utilizzate come filtro. ID della skill disponibile (in base alle autorizzazioni). Se questo field è vuoto, tutte le skill disponibili verranno utilizzate come filtro.

SkillVersion
string

Solo le skill disponibili possono essere filtrate per versione

StartDate
string<date-time>

Orario minimo di creazione delle transaction. L'orario deve essere definito nel formato UTC. Orario minimo di creazione delle transaction. L’orario deve essere specificato in formato UTC.

EndDate
string

Tempo massimo per la creazione delle transaction. L’orario deve essere specificato nel formato UTC. Se non viene fornito, verrà utilizzato l’orario UTC corrente. Data/ora massima di creazione delle Transaction. L’orario deve essere definito nel formato UTC. Se non specificato, verrà utilizzato l’orario UTC corrente.

TransactionParameters
object[]

Elenco dei Parameter della transaction. Le transaction recuperate devono contenere tutti i Parameter Elenco dei parametri di transaction. Le transaction recuperate devono includere tutti i parametri.

DocumentParameters
object[]

Elenco dei parametri del documento. Le transaction recuperate dovrebbero contenere tutti i parametri Elenco dei parametri del documento. Le transazioni recuperate devono includere tutti i parametri.

Offset
integer<int32>

Offset di paginazione (valore predefinito: 0)

Limit
integer<int32>

Limite di paginazione

Risposta

Transaction con Parameter di registrazione per le transaction e i relativi documenti e con informazioni sulla fase

Serve solo per Swagger

items
object[] | null
totalItemCount
integer<int32>