cja_get_projects {cjar}R Documentation

Get a paginated list of projects in CJA

Description

Retrieves a paginated list of projects, also known as ⁠Workspace Projects⁠.

Usage

cja_get_projects(
  includeType = "all",
  expansion = "definition",
  locale = "en_US",
  filterByIds = NULL,
  pagination = "true",
  ownerId = NULL,
  limit = 10,
  page = 0,
  debug = FALSE
)

Arguments

includeType

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

expansion

Comma-delimited list of additional segment metadata fields to include on response. See Details for all options available

locale

Locale - Default: "en_US"

filterByIds

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

pagination

Return paginated results

ownerId

Filter list to only include filters owned by the specified imsUserId

limit

Number of results per page

page

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

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: "shares" "tags" "accessLevel" "modified" "externalReferences" "definition"

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

Value

A data frame of projects and corresponding metadata

Examples

## Not run: 
cja_get_projects()

## End(Not run)

[Package cjar version 0.1.2 Index]