DataRetrievalController Class

The REST API provider for handling data retrieval requests.

Inheritance Hierarchy

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

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 DataRetrievalController : ApiControllerBase

Public Class DataRetrievalController
	Inherits ApiControllerBase

public ref class DataRetrievalController : public ApiControllerBase

type DataRetrievalController =  
    class
        inherit ApiControllerBase
    end

The DataRetrievalController type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	CancelRequest	Cancels a request with the given client data.
	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.)
	GetBatchData	Gets the data for the specified objects with the specified settings. Used mainly for scorecards/reports.
	GetBatchDataRegionStatistics	Gets the data statistics for the specified data region.
	GetClientIdFromCookieOrProvided	Gets the client ID from cookie or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
	GetData	Gets the data for the specified objects with the specified settings.
	GetDataRegionStatistics	Gets the data statistics for the specified data region.
	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.)
	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