GetFilteredBatches - ABBYY Documentation

Demande à un serveur un ensemble filtré de lots, par groupes. Par exemple, vous pouvez demander 100 lots se trouvant à l’étape de reconnaissance, à partir du 500e lot.

Définition

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)

Paramètres

Nom	Type	Description
`sessionId`	`int`	L’ID de la connexion au serveur d’applications.
`projectId`	`int`	L’ID du projet contenant les types de lots sur lesquels récupérer des informations.
`batchTypeId`	`int`	L’ID du type de lot. `0` sélectionne le lot par défaut. `-1` sélectionne tous les types de lots.
`stageTypes`	`int[]`	L’ensemble des types d’étape auxquels appartiennent les lots recherchés. Pour connaître les valeurs possibles, consultez ProcessingStage. Un ensemble vide sélectionne tous les lots. `0` sélectionne les lots qui ne se trouvent à aucune étape particulière.
`stageExtIds`	`int[]`	L’ensemble des ID d’étape (le champ `Id` de la structure ProcessingStage) auxquels appartiennent les lots recherchés. Un ensemble vide sélectionne tous les lots. `0` sélectionne les lots qui ne se trouvent à aucune étape particulière.
`name`	`string`	Le préfixe du nom du lot. Une chaîne vide signifie que n’importe quel nom est autorisé.
`batchPurpose`	`int`	La finalité du lot. `0` sélectionne les lots contenant des données. `1` sélectionne les lots destinés à l’entraînement de la mise en correspondance des Document Definition. `2` sélectionne les lots destinés à l’entraînement des classificateurs.
`startDate`	`long`	Lots créés après la date spécifiée. `0` sélectionne tous les lots. Pour convertir une valeur de date, utilisez l’exemple suivant ce tableau.
`stopDate`	`long`	Lots créés à partir de la date spécifiée. `0` sélectionne tous les lots. Pour convertir une valeur de date, utilisez l’exemple suivant ce tableau.
`slaDateBeginRange`	`long`	Lots dont la date de fin de traitement SLA est postérieure ou égale à la date spécifiée. `0` sélectionne tous les lots. Pour convertir une valeur de date, utilisez l’exemple suivant ce tableau.
`slaDateEndRange`	`long`	Lots dont la date de fin de traitement SLA est antérieure ou égale à la date spécifiée. `0` sélectionne tous les lots. Pour convertir une valeur de date, utilisez l’exemple suivant ce tableau.
`slaStateFlags`	`int`	Avertissement relatif à une échéance de traitement d’un lot. Utilisez l’une des valeurs indiquées après ce tableau, ou leur somme logique (OR).
`firstRecord`	`int`	Le premier enregistrement de la liste. Les enregistrements sont numérotés à partir de zéro.
`recordsCount`	`int`	Le nombre de lots à récupérer.
`filterRegParams`	RegistrationProperty`[]`	L’ensemble des paires nom-valeur utilisées pour filtrer selon les paramètres d’enregistrement. Seules 5 paires nom-valeur sont autorisées ; les autres sont ignorées.

Le paramètre slaStateFlags accepte les valeurs suivantes :

Valeur	Sélectionne
`0`	Ne filtre pas selon cet attribut.
`1`	Les lots sans échéance de traitement spécifiée.
`2`	Les lots dont l’échéance n’est ni proche ni dépassée.
`4`	Les lots dont l’échéance approche.
`8`	Les lots dont l’échéance est dépassée.

Convertissez une date entre long et DateTime en C# comme suit :

DateTime dTime;
long lTime;
...
// conversion de long en DateTime
dTime = DateTime.FromFileTime(lTime);
...
// conversion de DateTime en long
lTime = dTime.ToFileTime();

Valeur de retour

Type	Description
`int`	Le nombre de lots sur le serveur correspondant aux critères de filtre spécifiés.
Batch`[]`	L’ensemble des structures Batch achevées.

Les lots sont triés par ordre décroissant d’ID, de sorte que les lots les plus récents apparaissent en haut de la liste.