English (English) - Change language

GetAvailableTasksByStageId

What it does

Gets a list of tasks of the current session available at the specified processing stages.

Note: If stage allows Web stations, only preprocessed tasks will be added to the list.

Definition

Task [] GetAvailableTasksByStageId( int sessionId, int projectId, int[] stageIds, bool onlyPrivateBatches );
    

Parameters

Name Type Description
sessionId int The ID of the connection to the Application Server
projectId int The ID of the project for which the list of tasks is to be retrieved
stageIds int[] List of the IDs of the queues to get task from
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
Task[] List of available tasks

11/10/2020 12:08:04 PM


Please leave your feedback about this article