GetFilteredBatches

ステージ、date、SLA フィルターを使用して、ABBYY FlexiCapture Web Services API の GetFilteredBatches メソッドで、条件に一致する Batches のセットをページ分けして要求します。

サーバーから条件に一致する Batches のセットをグループ単位で要求します。たとえば、recognition ステージにある Batches を 500 番目の Batches から 100 件要求することができます。

​

定義

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)

​

パラメーター

Name	Type	Description
sessionId	int	Application Server への接続の ID。
projectId	int	情報を取得するBatchesタイプが含まれるプロジェクトの ID。
batchTypeId	int	Batchesタイプの ID。0 はデフォルトBatchesを選択します。-1 はすべてのBatchesタイプを選択します。
stageTypes	int[]	検索対象のBatchesがあるステージタイプのセット。使用可能な値については、ProcessingStage を参照してください。空のセットはすべてのBatchesを選択します。0 は特定のステージにないBatchesを選択します。
stageExtIds	int[]	検索対象のBatchesがあるステージ ID (ProcessingStage 構造体の Id field) のセット。空のセットはすべてのBatchesを選択します。0 は特定のステージにないBatchesを選択します。
name	string	Batches名のプレフィックス。空の文字列を指定すると、任意の名前が許可されます。
batchPurpose	int	Batchesの用途。0 はデータを含むBatchesを選択します。1 は Document Definition マッチングの学習用Batchesを選択します。2 は分類器の学習用Batchesを選択します。
startDate	long	指定した日付より後に作成されたBatches。0 はすべてのBatchesを選択します。日付値を変換するには、この表の後にある例を使用してください。
stopDate	long	指定した日付以降に作成されたBatches。0 はすべてのBatchesを選択します。日付値を変換するには、この表の後にある例を使用してください。
slaDateBeginRange	long	SLA 処理終了日が指定した日付以降のBatches。0 はすべてのBatchesを選択します。日付値を変換するには、この表の後にある例を使用してください。
slaDateEndRange	long	SLA 処理終了日が指定した日付以前のBatches。0 はすべてのBatchesを選択します。日付値を変換するには、この表の後にある例を使用してください。
slaStateFlags	int	Batches処理の期限に関する警告。この表の後にある値のいずれか、またはその論理和 (OR) を使用します。
firstRecord	int	リスト内の最初のレコード。レコード番号は 0 から始まります。
recordsCount	int	取得するBatchesの数。
filterRegParams	RegistrationProperty[]	登録パラメーターでフィルタリングするために使用する名前と値のペアのセット。指定できる値のペアは 5 つまでで、それ以外のペアは無視されます。

slaStateFlags パラメーターは次の値を取ります。

Value	Selects
0	この属性でフィルタリングしません。
1	処理期限が指定されていないBatches。
2	期限が近づいておらず、超過もしていないBatches。
4	期限が近づいているBatches。
8	期限を超過したBatches。

C# で long と DateTime の間で日付を変換するには、次のようにします。

DateTime dTime;
long lTime;
...
// long から DateTime への変換
dTime = DateTime.FromFileTime(lTime);
...
// DateTime から long への変換
lTime = dTime.ToFileTime();

​

戻り値

型	説明
int	指定したフィルター条件に一致するサーバー上のBatches数。
Batch[]	完了した Batch 構造体のセット。

BatchesはIDの降順で並べ替えられるため、最新のbatchがリストの先頭に表示されます。