JobController Class

The REST API for performing job-related tasks.

Inheritance Hierarchy

System.Object
  Microsoft.AspNetCore.Mvc.ControllerBase
    Dundas.BI.WebApi.Controllers.ApiControllerBase
      Dundas.BI.WebApi.Controllers.JobController

Namespace: Dundas.BI.WebApi.Controllers
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.1.0.1000)

Syntax

C++

Copy

public class JobController : ApiControllerBase

Public Class JobController
	Inherits ApiControllerBase

public ref class JobController : public ApiControllerBase

type JobController =  
    class
        inherit ApiControllerBase
    end

The JobController type exposes the following members.

Constructors

	Name	Description
	JobController	Initializes a new instance of the JobController class

Top

Methods

	Name	Description
	CancelJobById	Cancels a job.
	ClearOldJobs	Clears all the old jobs before a specified date.
	EnableJob	Enables or disables a job.
	EnsureCallerContext	If the current context is not already the specified context, creates a new caller context which is a clone of the specified context and sets it as the current one. (Inherited from ApiControllerBase.)
	EnsureFormFileMultipartContent	Ensures when form files are access the content is MIME multi-part which we want. (Inherited from ApiControllerBase.)
	GetClientIdFromCookieOrProvided	Gets the client ID from cookie or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
	GetJobById	Gets a job with the specified ID.
	GetJobRunById	Gets a job run with the specified ID.
	GetJobRunEvents	Get a list of JobRunEvent objects associated with the JobRun ID.
	GetJobRunsForJob	Gets the job runs associated with the given job ID.
	GetJobSchedule	Gets the schedule associated with a Job.
	GetLatestJobRunEvent	Gets the latest JobRunEvent object associated with the JobRun ID.
	GetLatestJobRunEventForJobs	Gets the latest job run events for the specified jobs.
	GetService<T>	Gets the requested service. (Inherited from ApiControllerBase.)
	GetSessionIdFromCookieHeaderOrProvided	Gets the session ID from cookie, the authorization header or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
	JobRunEventCount	Gets the number of job run events with the given information.
	JobRunEventQuery	Gets the job run events with the given information.
	LoadSession	Creates a new caller context associated with the specified session ID. The session is not validated. (Inherited from ApiControllerBase.)
	QueryJobRuns	Gets the job runs with the given information.
	QueryJobRunsCount	Gets the number of job runs with the given information.
	QueryJobs	Gets the jobs with the given information.
	QueryJobsCount	Gets the number of jobs with the given information.
	RequestFirstFormFile	Retrieves the first form file from the request. (Inherited from ApiControllerBase.)
	RequestFormFiles	Retrieves the form files from the request. (Inherited from ApiControllerBase.)
	ReturnInvalidWindowsIdentityResponse	Returns the invalid windows identity response to challenge the browser. (Inherited from ApiControllerBase.)
	RunJob	Runs a job.
	RunJob2	Runs a job using provided options.
	RunJobs	Runs a set jobs.
	SetJobMaintainer	Sets the job maintainer.
	UpdateScheduleRule	Updates a schedules rule.

Top

Reference

Dundas.BI.WebApi.Controllers Namespace