GetFilteredBatches - ABBYY Documentation

Requests a filtered set of batches from a server in groups. For example, you can request 100 batches at the recognition stage, starting from the 500th batch.

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)

Parameters

Name	Type	Description
`sessionId`	`int`	The ID of the connection to the Application Server.
`projectId`	`int`	The ID of the project that contains the batch types about which information is to be retrieved.
`batchTypeId`	`int`	The ID of the batch type. `0` selects the default batch. `-1` selects all batch types.
`stageTypes`	`int[]`	The set of stage types that have the batches you are looking for. For possible values, see ProcessingStage. An empty set selects all batches. `0` selects batches that are not at any particular stage.
`stageExtIds`	`int[]`	The set of stage IDs (the `Id` field in the ProcessingStage structure) that have the batches you are looking for. An empty set selects all batches. `0` selects batches that are not at any particular stage.
`name`	`string`	The prefix of the batch name. An empty string means that any name is allowed.
`batchPurpose`	`int`	The purpose of the batch. `0` selects batches with data. `1` selects batches for training Document Definition matching. `2` selects batches for training classifiers.
`startDate`	`long`	Batches created later than the specified date. `0` selects all batches. To convert a date value, use the example after this table.
`stopDate`	`long`	Batches created no earlier than the specified date. `0` selects all batches. To convert a date value, use the example after this table.
`slaDateBeginRange`	`long`	Batches with an SLA processing end date no earlier than the specified date. `0` selects all batches. To convert a date value, use the example after this table.
`slaDateEndRange`	`long`	Batches with an SLA processing end date no later than the specified date. `0` selects all batches. To convert a date value, use the example after this table.
`slaStateFlags`	`int`	A warning about a batch processing deadline. Use one of the values after this table, or their logical sum (OR).
`firstRecord`	`int`	The first record in the list. Records are numbered starting from the zero element.
`recordsCount`	`int`	The number of batches to obtain.
`filterRegParams`	RegistrationProperty`[]`	The set of name-value pairs used to filter by registration parameters. Only 5 value pairs are permitted; other pairs are ignored.

The slaStateFlags parameter takes the following values:

Value	Selects
`0`	Does not filter by this attribute.
`1`	Batches without a specified processing deadline.
`2`	Batches whose deadline is neither approaching nor approached.
`4`	Batches with an approaching deadline.
`8`	Batches with an approached deadline.

Convert a date between long and DateTime in C# as follows:

DateTime dTime;
long lTime;
...
// conversion from long to DateTime
dTime = DateTime.FromFileTime(lTime);
...
// conversion from DateTime to long
lTime = dTime.ToFileTime();

Returned value

Type	Description
`int`	The number of batches on the server that match the specified filter criteria.
Batch`[]`	The set of completed Batch structures.

Batches are sorted in descending order of ID, so the latest batches appear at the top of the list.