get_projects {galvanizer}

Retrieve Highbond Projects - Projects

Description

Downloads the primary details of one or all projects

Usage

get_projects(
  auth,
  project_id = NULL,
  fields = NULL,
  pagesize = 50,
  waittime = 0.2
)

Arguments

auth

Highbond authentication credentials, created from setup_highbond

project_id

Project ID number. NULL will default to all items.

fields

OPTIONAL. A character vector each field requested within the project. NULL will default to all fields.

pagesize

Defaults to 50. Maximum is 100.

waittime

Time in seconds to wait between requests.

Details

Fields allowed: name, state, status, created_at, updated_at, description, background, budget, position, certification, control_performance, risk_assurance, management_response, max_sample_size, number_of_testing_rounds, opinion, opinion_description, purpose, scope, start_date, target_date, tag_list, project_type, entities

Value

A tibble of projects

Examples

## Not run: 
projects <- get_projects(auth)
projects <- get_projects(auth, fields = c('name', 'state', 'status'))

## End(Not run)