XQuery admin:group-delete-scheduled-task-by-id

MarkLogic Server 11.0 Product Documentation
admin.groupDeleteScheduledTaskById

admin.groupDeleteScheduledTaskById(
   config as element(configuration),
   group-id as (Number|String),
   delete-ids as (Number|String)[]
) as element(configuration)

Summary

This function deletes the scheduled tasks for a group using 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.
delete-ids	The ID or IDs of the tasks to be deleted.

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()
admin.groupDeleteScheduledTaskById(config,
  admin.groupGetId(config,"Default"),17507568446985964051)

    //returns the new configuration element -- 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.groupDeleteScheduledTaskById

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.groupDeleteScheduledTaskById