projects_post: Create a project
In civis: R Client for the 'Civis Platform API'

projects_post

R Documentation

Create a project

Description

Create a project

Usage

projects_post(name, description, note = NULL, auto_share = NULL, hidden = NULL)

Arguments

`name`	string required. The name of this project.
`description`	string required. A description of the project.
`note`	string optional. Notes for the project.
`auto_share`	boolean optional. If true, objects within the project will be automatically shared when the project is shared or objects are added.
`hidden`	boolean optional. The hidden status of the item.

Value

A list containing the following elements:

`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,
`tables`	array, An array containing the following fields: schema string, name string, rowCount integer, columnCount integer, createdAt string, updatedAt string,
`surveys`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string,
`scripts`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, type string, finishedAt string, state string, lastRun object,
`imports`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, type string, finishedAt string, state string, lastRun object,
`exports`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, type string, finishedAt string, state string, lastRun object,
`models`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, state string,
`notebooks`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, currentDeploymentId integer, lastDeploy object,
`services`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, currentDeploymentId integer, lastDeploy object,
`workflows`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, state string, lastExecution object,
`reports`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, state string,
`scriptTemplates`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string,
`files`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, fileName string, fileSize integer, expired boolean,
`enhancements`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, lastRun object,
`projects`	array, An array containing the following fields: id integer, The item's ID. createdAt string, updatedAt string, name string, description string,
`allObjects`	array, An array containing the following fields: projectId integer, objectId integer, objectType string, fcoType string, subType string, name string, icon string, author string, updatedAt string, autoShare boolean, archived string, The archival status of the requested item(s). hidden boolean, The hidden status of the item. myPermissionLevel string, Your permission level on the object. One of "read", "write", or "manage".
`note`	string,
`canCurrentUserEnableAutoShare`	boolean, A flag for if the current user can enable auto-sharing mode for this project.
`hidden`	boolean, The hidden status of the item.
`archived`	string, The archival status of the requested item(s).
`parentProject`	list, A list containing the following elements: id integer, The parent project's ID. name integer, The parent project's name.
`myPermissionLevel`	string, Your permission level on the object. One of "read", "write", or "manage".