RP_APIListDataSet: RP_APIListDataSet

In RavenPack/r-api: RavenPack API to Self Service Platform

RP_APIListDataSet

Description

List all available datasets. Get a list of the datasets that you have permission to access. You may filter the list by tags and search for only the list of datasets that have the tags specified, or you may filter by scope, and return only the datasets that are Public to everyone, Shared with you by someone else using RavenPack or Private datasets that were created by you. The list of datasets returns the dataset_uuid and name for each dataset. It is possible to request the full set of information that defines a dataset using the API.

Usage

RP_APIListDataSet(APIHandler, params = list())

Arguments

APIHandler	An API handler, created using RP_CreateAPIHandler
params	A list with the request query parameters. tags: Optional. A list of tags that should be used to filter the list of datasets returned. scope: Optional. A list with the desired scope: [public, shared, private (default)] frequency: Optional. A list with the desired type of dataset: [daily, granular]

Value

A data.table with the datasets.

Author(s)

Jose A. Guerrero-Colon

RavenPack/r-api documentation built on July 30, 2022, 9:56 p.m.