notebooks_list_projects: List the projects a Notebook belongs to

View source: R/generated_client.R

notebooks_list_projectsR Documentation

List the projects a Notebook belongs to

Description

List the projects a Notebook belongs to

Usage

notebooks_list_projects(id, hidden = NULL)

Arguments

id

integer required. The ID of the Notebook.

hidden

boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

Value

An array containing the following fields:

id

integer, The ID for this project.

author

list, A list containing the following elements:

  • id integer, The ID of this user.

  • name string, This user's name.

  • username string, This user's username.

  • initials string, This user's initials.

  • online boolean, Whether this user is online.

name

string, The name of this project.

description

string, A description of the project.

users

array, An array containing the following fields:

  • id integer, The ID of this user.

  • name string, This user's name.

  • username string, This user's username.

  • initials string, This user's initials.

  • online boolean, Whether this user is online.

autoShare

boolean,

createdAt

string,

updatedAt

string,

archived

string, The archival status of the requested item(s).


civis documentation built on April 1, 2023, 12:01 a.m.