cja_get_dateranges {cjar}

Get a paginated list of dateranges in CJA

Description

This function allows users to pull a list of stored date ranges so that they can be reused in an analysis.

Usage

cja_get_dateranges(
  locale = "en_US",
  filterByIds = NULL,
  limit = 10,
  page = 0,
  expansion = "definition",
  includeType = "all",
  debug = FALSE
)

Arguments

locale

Locale - Default: "en_US"

filterByIds

Filter list to only include date ranges in the specified list (comma-delimited list of IDs). This has filtered Ids from tags, approved, favorites and user specified Ids list.

limit

Number of results per page. default is 10

page

Page number (base 0 - first page is "0")

expansion

Comma-delimited list of additional date range metadata fields to include on response.

includeType

Include additional filters not owned by user. Default is "all". Options include: "all" (default), "shared", "templates"

debug

Used to help troubleshoot api call issues. Shows the call and result in the console

Details

expansion options can include any of the following: "definition" "modified" "ownerFullName" "sharesFullName" "shares" "tags"

includeType options can include any of the following: "all", "shared", "templates"

Value

A data frame of dateranges and their corresponding metadata

Examples

## Not run: 
cja_get_dateranges()

## End(Not run)