Operations at BackgroundJobManagement

This page describes the backend methods at this endpoint.

Signature | Description
--- | ---
Void CancelAllJobsForAgents(CancelAgentJobsRequest request) | Cancels all active jobs for a provided list of agents
Void CancelChildJob(String parentJobId, String childJobId) | Cancels the child job.
Void CancelJob(String jobId) | Cancels the job.
Void CancelJobs(GuidCollection jobIds) | Cancels specified jobs.
BackgroundJobServiceConfiguration GetBackgroundJobsConfiguration() | Gets background jobs configuration.
BackgroundJosProcessingState GetBackgroundJobsProcessingState() | Gets state of background jobs processing (running / suspended / stopped).
BackgroundJobInfo GetJob(String jobId) | Gets the specified job.
BackgroundJobInfoCollection GetJobs(BackgroundJobSearchParameters searchParameters) | Gets all jobs that pass through specified filter, in memory and database.
BackgroundJobInfoLightCollection GetJobsByPage(String jobsPerPage, String page, BackgroundJobSearchParameters searchParameters) | Gets the current list of jobs that pass through specified filter, paged for easy viewing in a paged grid.
Int32 GetJobsCount(BackgroundJobSearchParameters searchParameters) | Gets the current number of jobs that pass through specified filter, in memory and database.
Void ResetBackgroundJobSettings(BackgroundJobType backgroundJobType) | Resets background job's settings to default.
Void ResumeBackgroundJobsProcessing() | Resumes processing of background jobs (any queued jobs will be started if it's possible.)
Void SuspendBackgroundJobsProcessing(String cancelRunningJobs) | Suspends processing of background jobs (new jobs will be added to the queue, but won't be started.)
Void UpdateBackgroundJobSettings(BackgroundJobSettings backgroundJobSettings) | Updates background job's settings.