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.

Hierarchy

  • RVDashboardDataSource
    • RVRESTDataSource

Index

Constructors

constructor

Accessors

body

  • get body(): nullableString
  • set body(value: nullableString): void
  • Body to send, expected to be used only with POST and PUT methods.

    Returns nullableString

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

    Parameters

    • value: nullableString

    Returns void

contentType

  • get contentType(): nullableString
  • set contentType(value: nullableString): void
  • Content type of the body, only used when body is not empty

    Returns nullableString

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

    Parameters

    • value: nullableString

    Returns void

defaultRefreshRate

  • get defaultRefreshRate(): null | number
  • set defaultRefreshRate(v: null | number): void
  • Returns null | number

  • Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g. 1440 = 1 day). A value of N means that whenever the visualization requests data, the engine will return data found in the cache if it's not older than N minutes -this means, if the engine fetched it from the datasource no more than N minutes before-. Set it to override the widget editor default behavior.

    Parameters

    • v: null | number

    Returns void

headers

  • get headers(): null | any[]
  • set headers(value: null | any[]): void
  • List of headers to send in the request, each string in this list is expected to be a string in the format name=value.

    Returns null | any[]

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

    Parameters

    • value: null | any[]

    Returns void

id

  • get id(): nullableString
  • set id(value: nullableString): void
  • The ID of the data source

    Returns nullableString

  • The ID of the data source

    Parameters

    • value: nullableString

    Returns void

method

  • get method(): nullableString
  • set method(value: nullableString): void
  • HTTP method to use, it defaults to GET

    Returns nullableString

  • HTTP method to use, it defaults to GET

    Parameters

    • value: nullableString

    Returns void

subtitle

  • get subtitle(): nullableString
  • set subtitle(value: nullableString): void
  • The subtitle of the data source, if not null will be displayed to users instead of connection information like host and database name.

    Returns nullableString

  • The subtitle of the data source, if not null will be displayed to users instead of connection information like host and database name.

    Parameters

    • value: nullableString

    Returns void

title

  • get title(): nullableString
  • set title(value: nullableString): void
  • The title of the data source as displayed to users.

    Returns nullableString

  • The title of the data source as displayed to users.

    Parameters

    • value: nullableString

    Returns void

url

  • get url(): nullableString
  • set url(value: nullableString): void

useAnonymousAuthentication

  • get useAnonymousAuthentication(): boolean
  • set useAnonymousAuthentication(value: boolean): void
  • Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void