Skip to main content

​
What it does

Gets information about all the batches in a project.

​
Definition

Batch [] GetBatches( int projectId, int sessionId, bool onlyPrivateBatches );

​
Parameters

Name

Type

Description

projectId

int

The ID of the project that contains the batches about which information is to be retrieved

sessionId

int

The ID of the connection to the Application Server

onlyPrivateBatches

bool

The flag which determines the set of available batches. Possible values:

  • True - only batches that belong the current user or user group are available;
  • False - all batches are available

​
Returned value

Type

Description

Batch[]

A set of records, each containing information about one of the batches in the project.

The returned set does not include batches created in the Web Capture Station.