Zum Hauptinhalt springen
GET
/
api
/
publicapi
/
v1
/
transactions
/
active
Gibt aktive Vorgänge mit den angegebenen Parametern zurück
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
}

Autorisierungen

​
Authorization
string
header
erforderlich

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

Abfrageparameter

​
StageType
string

Aktueller Status des Vorgangs

​
StageName
string

Name der aktuellen Vorgangsphase Name der aktuellen Stufe des Vorgangs

​
SkillId
string

ID einer verfügbaren Skill (gemäß den Berechtigungen). Wenn dieses Feld leer ist, werden alle verfügbaren Skills als Filter verwendet. ID der verfügbaren Skills (gemäß Berechtigungen). Wenn dieses Feld leer ist, werden alle verfügbaren Skills als Filter verwendet.

​
SkillVersion
string

Nur verfügbare Skills lassen sich nach ihren Versionen filtern Nur verfügbare Skills können nach ihren Versionen gefiltert werden

​
StartDate
string<date-time>

Früheste Erstellungszeit der Vorgänge. Die Zeit muss im UTC-Format angegeben werden. Frühester Erstellungszeitpunkt der Vorgänge. Die Zeit muss im UTC-Format angegeben werden.

​
EndDate
string

Maximale Erstellungszeit der Vorgänge. Der Zeitpunkt muss in UTC angegeben werden. Wenn kein Wert angegeben ist, wird die aktuelle UTC-Zeit verwendet. Spätester Erstellungszeitpunkt der Vorgänge. Der Zeitpunkt muss im UTC-Format angegeben werden. Wenn kein Wert angegeben wird, wird die aktuelle UTC-Zeit verwendet.

​
TransactionParameters
object[]

Liste der Vorgangsparameter. Die abgerufenen Vorgänge sollten alle Parameter enthalten. Liste der Vorgangsparameter. Abgerufene Vorgänge sollten sämtliche Parameter enthalten

​
DocumentParameters
object[]

Liste der Dokumentparameter. Abgerufene Vorgänge sollten alle Parameter enthalten Liste der Dokumentparameter. Die abgerufenen Vorgänge sollten alle Parameter enthalten

​
Offset
integer<int32>

Paginierungsoffset (Standardwert: 0) Paginierungsoffset (Standard: 0)

​
Limit
integer<int32>

Pagination-Limit Paginierungsgrenze

Antwort

Vorgänge mit Registrierungsparametern für die Vorgänge und ihre Dokumente sowie mit Stufeninformationen

Dies wird nur für Swagger verwendet

​
items
object[] | null
​
totalItemCount
integer<int32>