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

Index

Accessors

  • get body(): nullableString

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

    Returns nullableString

  • set body(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get contentType(): nullableString

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

    Returns nullableString

  • set contentType(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get defaultRefreshRate(): number | null

    Returns number | null

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

    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: number | null

    Returns void

  • get headers(): any[] | null

    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 any[] | null

  • set headers(value: any[] | null): void

    Parameters

    • value: any[] | null

    Returns void

  • get id(): nullableString

    The ID of the data source

    Returns nullableString

  • set id(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get method(): nullableString

    HTTP method to use, it defaults to GET

    Returns nullableString

  • set method(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get subtitle(): nullableString

    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

  • set subtitle(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get title(): nullableString

    The title of the data source as displayed to users.

    Returns nullableString

  • set title(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get url(): nullableString

    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 RVRESTDataSourceItem.parameters property of RVRESTDataSourceItem.

    Returns nullableString

  • set url(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get useAnonymousAuthentication(): boolean

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

    Returns boolean

  • set useAnonymousAuthentication(value: boolean): void

    Parameters

    • value: boolean

    Returns void

  • get usePreemptiveAuthentication(): boolean

    Boolean flag indicating if preemptive authentication should be used for this data source.

    Returns boolean

  • set usePreemptiveAuthentication(value: boolean): void

    Parameters

    • value: boolean

    Returns void