Get Batch Task Infos By Associates
Get an array of BatchTaskInfo for the provided associate id’s.
NsApiSlow threshold: 3000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
AssociateIds
GetBatchTaskInfosByAssociates: Get an array of BatchTaskInfo for the provided associate id's.
Response
OK
Id of the task.
Name of the task.
Task owner. If it is a System task, AssociateId = 0.
Id of table with more information about the task.
Record Id of a row in the DetailsTable containing more info about the task.
If IsSystemTask is true, the task is not initiated by an associate.
If IsInternalTask is true, this task will not add a trace to the database.
ParameterObject will be serialized to a binary blob and saved in the BinaryObject table. The link to the BinaryObject will be set using DetailsTable and DetailsRecord.
When was the task last started.
Task creation time.
Maps to the startcount field in the batchtask table.
Serial number of the database the task is to run on.
Context for the executing task.
Maps to the result field in the batchtask table.
BatchTaskState of the task.
Unknown, New, Aquired, Started, Succeeded, Failed, SucceededManualCleanup, All Description of the task.
Maps to the response field in the batchtask table.
Maps to the request field in the batchtask table.
Descriptive text for the current stage
Task progress, in percent of estimated total
The filename related to the batchtask.
Indicate if the task can be stopped.
CanCancel, CancelWithWarning, CannotCancel Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Batch Task Infos By Associates And StateNSBatchAgentGet Batch Task Infos By Name And AssociatesNSBatchTaskInfoGet Batch Task Info