Loading TOC...

admin.groupGetScheduledTask

admin.groupGetScheduledTask(
   config as element(configuration),
   group-id as (Number|String),
   task-id as (Number|String)
) as element(gr.scheduledTask)?

Summary

This function returns information about a scheduled task for a group based on the task ID and the group ID.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-id The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
task-id The ID of the task.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{id}

Example

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
admin.groupGetScheduledTask(config,
      (admin.groupGetId(config,"Default")),17507568446985964051)
 =>
 element

<scheduledTask xmlns.xsi="http://www.w3.org/2001/XMLSchemaInstance" xmlns="http://marklogic.com/xdmp/group">
 <taskId>17507568446985964051</taskId>
 <taskEnabled>true</taskEnabled>
 <taskPath>/MarkLogic/flexrep/tasks/pushLocalForests.xqy</taskPath>
 <taskRoot>Modules</taskRoot>
 <taskType>minutely</taskType>
 <taskPeriod>1</taskPeriod>
<taskDays></taskDays>
 <taskTimestamp>20141110T11.00.44.10908.00</taskTimestamp>
 <taskDatabase>8250162625324183727</taskDatabase>
 <taskModules>0</taskModules>
 <taskUser>12367085613665751917</taskUser>
 <taskHost>0</taskHost>
 <taskPriority>normal</taskPriority>
</scheduledTask>
  //returns information about this task 
    

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.