get_project_narratives: Retrieve Highbond Project - Narratives

Description Usage Arguments Details Value

View source: R/projects.R

Description

"A narrative is a description of a business process or area under review. Narratives are also known as policies, process narratives, process descriptions, or control guides."

Usage

1
2
3
4
5
6
7
8
get_project_narratives(
  auth,
  objective_id = NULL,
  narrative_id = NULL,
  fields = NULL,
  pagesize = 50,
  waittime = 0.2
)

Arguments

auth

Highbond authentication credentials, created from setup_highbond

objective_id

Required if other parameter is blank. May obtain multiple rows.

narrative_id

Required if other parameter is blank. Will get only one row.

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

possible fields: title, description, created_at, updated_at, objective

Value

A tibble of narratives


galvanizer documentation built on May 28, 2021, 5:14 p.m.