XQuery admin:group-delete-scheduled-task

MarkLogic Server 11.0 Product Documentation
admin.groupDeleteScheduledTask

admin.groupDeleteScheduledTask(
   config as element(configuration),
   group-id as (Number|String),
   scheduled-tasks as element(gr.scheduledTask)[]
) as element(configuration)

Summary

This function deletes one or more scheduled tasks from the specified group.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
group-id	The ID of the group on which the scheduled tasks are configured. Typically, this is the result of an `admin:group-get-id` call.
scheduled-tasks	One or more scheduled tasks.

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}

http://marklogic.com/xdmp/privileges/admin/group/scheduled-task

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const group = admin.groupGetId(config, "Default")
  const tasks = admin.groupGetScheduledTasks(config, group)
   admin.groupDeleteScheduledTask(config, group, tasks)

   //Returns a configuration element with the scheduled tasks in the
      "Default" group deleted -- use admin.saveConfiguration
    //to save the changes to the configuration or pass the configuration
    //to other Admin API functions to make other changes.

MarkLogic Server 11.0 Product Documentationadmin.groupDeleteScheduledTask

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.groupDeleteScheduledTask