English (English) - Change language

GetTask

What it does

Selects the task with the highest priority and opens it for processing. The selected task is locked (i.e. cannot be opened by other users).

Note: If there is no suitable task, "0" is returned.

Important! A task must be opened before any actions on the task can be performed!

Definition

int GetTask( int sessionId, int projectId, int stageType, bool onlyPreprocessedTask, bool onlyPrivateBatches );
    

Parameters

Name Type Description
sessionId int The ID of the connection to the Application Server
projectId int Project ID
stageType int The ID of the stage type. See ProcessingStage for possible values.
onlyPreprocessedTask bool

The flag which determines from which tasks to select. Possible values:

  • True - select only pre-processed tasks;
  • False - select from all tasks.
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
int Task ID

9/15/2020 9:42:43 AM


Please leave your feedback about this article