Passer au contenu principal

Ce que cela fait

Demande au serveur un ensemble filtré de lots, par groupes. Par exemple, vous pouvez envoyer une requête du type : « renvoyer 100 lots au stade 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

sessionId

int

L’ID de connexion au serveur d’applications

projectId

int

L’ID du projet contenant les types de lots pour lesquels des informations doivent être récupérées

batchTypeId

int

L’ID du type de lot

  • 0 - lot par défaut
  • -1 - tous les types de lots

stageTypes

int []

Ensemble des types d’étape (pour les valeurs possibles, voir ProcessingStage) auxquels appartiennent les lots recherchés

  • Ensemble vide - tous les lots
  • 0 - lots qui ne se trouvent à aucune étape particulière

stageExtIds

int []

Ensemble des ID d’étape (le champ Id dans la structure ProcessingStage) correspondant aux lots que vous recherchez

  • Ensemble vide - tous les lots
  • 0 - lots ne se trouvant à aucune étape particulière

name

string

Le préfixe du nom du batch. Une ligne vide signifie que tous les noms sont autorisés

batchPurpose

int

La finalité du lot

Valeurs possibles :

  • 0 - lots contenant des données
  • 1 - lots destinés à l’entraînement de la mise en correspondance de Document Definition
  • 2 - lots destinés à l’entraînement des classificateurs

startDate

long

Lots créés après la date spécifiée ; 0 indique tous les lots

Pour la conversion, utilisez les méthodes suivantes (l’exemple ci-dessous est en C#) :

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

stopDate

long

Lots créés à partir de la date spécifiée ; 0 indique tous les lots

Pour la conversion, utilisez les méthodes suivantes (l’exemple ci-dessous est en C#) :

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

slaDateBeginRange

long

Les batches dont la date de fin de traitement dans le cadre d’un SLA n’est pas antérieure à la date spécifiée ; 0 correspond à tous les batches

Pour la conversion, utilisez les méthodes suivantes (l’exemple ci-dessous est en C#) :

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

slaDateEndRange

long

Les lots dont la date de fin de traitement dans le cadre d’un SLA n’est pas postérieure à la date spécifiée ; 0 correspond à tous les lots

Pour la conversion, utilisez les méthodes suivantes (l’exemple ci-dessous est en C#) :

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

slaStateFlags

int

Contient un avertissement relatif à l’échéance de traitement d’un lot

Les valeurs suivantes, ou leur combinaison logique (OR), sont autorisées :

  • 0 - les lots ne sont pas filtrés selon cet attribut
  • 1 - les lots sans échéance de traitement spécifiée
  • 2 - les lots avec une échéance de traitement qui n’est ni imminente ni atteinte
  • 4 - les lots avec une échéance de traitement imminente
  • 8 - les lots avec une échéance de traitement atteinte

firstRecord

int

Le premier enregistrement de la liste

(Les enregistrements sont numérotés à partir de l’élément 0)

recordsCount

int

Le nombre de lots qu’un utilisateur tente d’obtenir

filterRegParams

RegistrationProperty[]

Ensemble de paires « nom-valeur » utilisé pour filtrer selon les paramètres d’enregistrement

(Il est possible d’envoyer uniquement 5 paires de valeurs ; les autres seront ignorées)

Les lots sont triés par ID décroissant, ce qui signifie que les lots les plus récents apparaissent en tête de liste.

Valeur de retour

TypeDescription
intLe nombre de lots sur le serveur correspondant aux critères de filtre spécifiés
Batch[]L’ensemble des structures Batch achevées