HealthController Class

The REST API for performing DBI Health related tasks.

Inheritance Hierarchy

SystemObject
  Microsoft.AspNetCore.MvcControllerBase
    Dundas.BI.WebApi.ControllersApiControllerBase
      Dundas.BI.WebApi.ControllersHealthController

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

Syntax

C++

Copy

public class HealthController : ApiControllerBase

Public Class HealthController
	Inherits ApiControllerBase

public ref class HealthController : public ApiControllerBase

type HealthController =  
    class
        inherit ApiControllerBase
    end

The HealthController type exposes the following members.

Constructors

	Name	Description
	HealthController	Initializes a new instance of the HealthController class.

Top

Methods

	Name	Description
	CancelHealthCheck	Cancels the health check with the corresponding context ID.
	CheckHealth	Starts the health check.
	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.)
	GetHealthChecks	Gets the registered health checks.
	GetHealthStatus	Gets the health check status.
	GetServiceT	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.)
	IsAlive	Gets an empty OK result to indicate that the Dundas BI application is running.
	LoadSession	Creates a new caller context associated with the specified session ID. The session is not validated. (Inherited from ApiControllerBase.)
	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.)

Top

Reference

Dundas.BI.WebApi.Controllers Namespace