JavaScript admin.groupDeleteScheduledTask

MarkLogic 10 Product Documentation
admin:group-delete-scheduled-task

admin:group-delete-scheduled-task(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $scheduled-tasks as element(gr:scheduled-task)*
) 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


  xquery version "1.0-ml";
  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $group := admin:group-get-id($config, "Default")
  let $tasks := admin:group-get-scheduled-tasks($config, $group)

  return
   admin:group-delete-scheduled-task($config, $group, $tasks)

  (: Returns a configuration element with the scheduled tasks in the
      "Default" group deleted -- use admin:save-configuration
      to save the changes to the configuration or pass the configuration
      to other Admin API functions to make other changes. :)

MarkLogic 10 Product Documentationadmin:group-delete-scheduled-task

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:group-delete-scheduled-task