civis (version 1.1.0)

projects_post: Create a project

Description

Create a project

Usage

projects_post(name, description, note = 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

hidden

boolean optional. The hidden status of the object.

Value

A list containing the following elements:

id

integer, The ID for this project.

author

object, 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 object ID.

• createdAt string,

• updatedAt string,

scripts

array, An array containing the following fields:

• id integer, The object ID.

• createdAt string,

• updatedAt string,

• name string,

• type string,

• finishedAt string,

• state string,

imports

array, An array containing the following fields:

• id integer, The object ID.

• createdAt string,

• updatedAt string,

• name string,

• type string,

• finishedAt string,

• state string,

models

array, An array containing the following fields:

• id integer, The object ID.

• createdAt string,

• updatedAt string,

• name string,

• state string,

notebooks

array, An array containing the following fields:

• id integer, The object ID.

• createdAt string,

• updatedAt string,

• name string,

• currentDeploymentId integer,

workflows

array, An array containing the following fields:

• id integer, The object ID.

• createdAt string,

• updatedAt string,

• name string,

• state string,

reports

array, An array containing the following fields:

• id integer, The object ID.

• createdAt string,

• updatedAt string,

• name string,

• state string,

scriptTemplates

array, An array containing the following fields:

• id integer, The object ID.

• createdAt string,

• updatedAt string,

• name string,

files

array, An array containing the following fields:

• id integer, The object ID.

• createdAt string,

• updatedAt string,

• fileName string,

• fileSize integer,

• expired boolean,

appInstances

array, An array containing the following fields:

• id integer, The object ID.

• createdAt string,

• updatedAt string,

• name string,

• slug 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,

• archived string, The archival status of the requested object(s).

note

string,

hidden

boolean, The hidden status of the object.

archived

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