Zum Hauptinhalt springen

Was es macht

Fordert vom Server gruppenweise eine gefilterte Menge von Batches an. Sie können zum Beispiel eine Anfrage senden, die wie folgt aussieht: „Gib 100 Batches zurück, die sich ab dem 500. Batch in der Erkennungsphase befinden.“

Definition

int GetFilteredBatches(int sessionId, int projectId, int batchTypeId, int[] stageTypes, int[] stageExtIds, string name, int batchPurpose, long startDate, long stopDate, long slaDateBeginRange, long slaDateEndRange, int slaStateFlags, int firstRecord, int recordsCount, RegistrationProperty[] filterRegParams, out Batch[] batches)

Parameter

sessionId

int

Die ID der Verbindung zum Application Server

projectId

int

Die ID des Projekts, das die Batch-Typen enthält, für die Informationen abgerufen werden sollen

batchTypeId

int

Die ID des Batch-Typs

  • 0 - Standard-Batch
  • -1 - alle Batch-Typen

stageTypes

int []

Die Menge der Stufentypen (mögliche Werte finden Sie unter ProcessingStage), zu denen die gesuchten Batches gehören

  • Leere Menge – alle Batches
  • 0 – Batches, die sich in keiner bestimmten Stufe befinden

stageExtIds

int []

Die Menge an Stufen-IDs (das Feld Id in der Struktur ProcessingStage), zu denen die gesuchten Batches gehören

  • Leere Menge - alle Batches
  • 0 - Batches, die sich in keiner bestimmten Stufe befinden

name

string

Das Präfix des Batch-Namens. Eine leere Zeile bedeutet, dass alle Namen zulässig sind

batchPurpose

int

Der Zweck des Batches

Mögliche Werte:

  • 0 - Batches mit Daten
  • 1 - Batches zum Trainieren des Matchings von Document Definitions
  • 2 - Batches zum Trainieren von Klassifikatoren

startDate

long

Batches, die nach dem angegebenen Datum erstellt wurden; 0 steht für alle Batches

Verwenden Sie für die Konvertierung die folgenden Methoden (das nachstehende Beispiel ist in C#):

DateTime dtTime; long lTime; … // Konvertierung von DataTime in long dTime = DataTime.FromFileTime(lTime); … // Konvertierung von long in DataTime lTime = dTime.ToFileTime();

stopDate

long

Batches, die frühestens am angegebenen Datum erstellt wurden; 0 steht für alle Batches

Für die Konvertierung verwenden Sie die folgenden Methoden (das folgende Beispiel ist in C#):

DateTime dtTime; long lTime; … // Konvertierung von DataTime zu long dTime = DataTime.FromFileTime(lTime); … // Konvertierung von long zu DataTime lTime = dTime.ToFileTime();

slaDateBeginRange

long

Batches, deren Verarbeitungsenddatum im Rahmen einer SLA nicht vor dem angegebenen Datum liegt; 0 steht für alle Batches

Verwenden Sie für die Konvertierung die folgenden Methoden (das folgende Beispiel ist in C#):

DateTime dtTime; long lTime; … // Konvertierung von DataTime in long dTime = DataTime.FromFileTime(lTime); … // Konvertierung von long in DataTime lTime = dTime.ToFileTime();

slaDateEndRange

long

Batches, deren SLA-Verarbeitungsenddatum nicht nach dem angegebenen Datum liegt; 0 steht für alle Batches

Verwenden Sie für die Konvertierung die folgenden Methoden (das folgende Beispiel ist in C#):

DateTime dtTime; long lTime; … // Konvertierung von DataTime in long dTime = DataTime.FromFileTime(lTime); … // Konvertierung von long in DataTime lTime = dTime.ToFileTime();

slaStateFlags

int

Enthält eine Warnung bezüglich der Verarbeitungsfrist eines Batches

Die folgenden Werte oder ihre logische Summe (OR) sind zulässig:

  • 0 - Batches werden nicht nach diesem Attribut gefiltert
  • 1 - Batches ohne angegebene Verarbeitungsfrist
  • 2 - Batches mit einer Verarbeitungsfrist, die weder bevorsteht noch erreicht ist
  • 4 - Batches mit einer bevorstehenden Verarbeitungsfrist
  • 8 - Batches mit einer erreichten Verarbeitungsfrist

firstRecord

int

Der erste Datensatz in der Liste

(Datensätze werden ab dem Element mit Index null nummeriert)

recordsCount

int

Die Anzahl der Batches, die ein Benutzer abrufen möchte

filterRegParams

RegistrationProperty[]

Die Menge der „Name-Wert“-Paare, die zum Filtern nach Registrierungsparametern verwendet wird

(Es dürfen nur 5 Wertepaaren gesendet werden, andere Paare werden ignoriert)

Batches sind nach IDs in absteigender Reihenfolge sortiert. Das bedeutet, dass die neuesten Batches oben in der Liste zurückgegeben werden.

Rückgabewert

TypBeschreibung
intDie Anzahl der Batches auf dem Server, die den angegebenen Filterkriterien entsprechen
Batch[]Die Sammlung abgeschlossener Batch-Strukturen