Class RVRESTDataSource

REST API data source, configures the URL to get data from, HTTP method to use and optionally headers and body to send in the request.

Inheritance
System.Object
RVDashboardDataSource
RVRESTDataSource
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Reveal.Sdk
Assembly: Reveal.UI.Sdk.dll
Syntax
public class RVRESTDataSource : RVDashboardDataSource

Constructors

RVRESTDataSource()

Declaration
public RVRESTDataSource()

Properties

Body

Body to send, expected to be used only with POST and PUT methods.

Declaration
public string Body { get; set; }
Property Value
Type Description
System.String

ContentType

Content type of the body, only used when Body is not empty

Declaration
public string ContentType { get; set; }
Property Value
Type Description
System.String

Headers

List of headers to send in the request, each string in this list is expected to be a string in the format name=value.

Declaration
public List<string> Headers { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

Method

HTTP method to use, it defaults to GET

Declaration
public string Method { get; set; }
Property Value
Type Description
System.String

Url

URL to the web resource, is expected to be a URL with HTTP or HTTPS scheme. Parameters might be specified using the notation {parameterName}, for example: http://server/customers/{CustomerID} defines a "CustomerID" parameter that must be included in the Parameters property of RVRESTDataSourceItem.

Declaration
public string Url { get; set; }
Property Value
Type Description
System.String

UseAnonymousAuthentication

Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.

Declaration
public bool UseAnonymousAuthentication { get; set; }
Property Value
Type Description
System.Boolean