French (Français) - Change language

CreateTask

What it does

Creates a task from the set of documents of one batch.

Definition

int CreateTask( int sessionId, int batchId, int stageExternalId, int priority, string comment, int UserId, int[] docIds, bool setAsCurrentTask );

Parameters

Name Type Description
sessionId int The ID of the connection to the Application Server
batchId int The ID of the batch that contains the document about which information is to be retrieved
stageExternalId int The ID of the stage the task will be placed in
priority int The priority of the task. See Priority for possible values.
comment string A text comment to the task
userId int The ID of the user the task will be assigned to. If the group ID is specified, the task can be processed by any user of the group. If the value is "0" the task can be processed by any user who is allowed to process this queue in the given batch type. For queues processed by the Processing Server, this parameter is ignored.
docIds int[] The IDs of the batch documents
setAsCurrentTask bool

The flag that shows whether the task will be set as a current task or will be placed in a queue. Possible values:

  • True - the task will be set as a current task for the user who called the method;
  • False - the task will be placed in a queue.

Returned value

Type Description
int Task ID

13.04.2021 11:12:28


Please leave your feedback about this article