Projects

class Projects(session_kwargs, client, return_type='raw')

Methods

`delete_parent_projects`(id, parent_project_id)	Remove an item from a Parent Project
`delete_shares_groups`(id, group_id)	Revoke the permissions a group has on this object
`delete_shares_users`(id, user_id)	Revoke the permissions a user has on this object
`get`(project_id)	Get a detailed view of a project and the objects in it
`list`(*[, permission, auto_share, author, ...])	List projects
`list_dependencies`(id, *[, user_id])	List dependent objects for this object
`list_parent_projects`(id, *[, hidden])	List the Parent Projects an item belongs to
`list_shares`(id)	List users and groups permissioned on this object
`post`(name, description, *[, note, ...])	Create a project
`post_clone`(id, *[, clone_schedule, ...])	Clone this
`put`(project_id, *[, name, description, note])	Update a project
`put_archive`(id, status)	Update the archive status of this object
`put_auto_share`(project_id, auto_share)	Enable or disable Auto-Share on a project
`put_parent_projects`(id, parent_project_id)	Add an item to a Parent Project
`put_shares_groups`(id, group_ids, ...[, ...])	Set the permissions groups has on this object
`put_shares_users`(id, user_ids, ...[, ...])	Set the permissions users have on this object
`put_transfer`(id, user_id, ...[, email_body, ...])	Transfer ownership of this object to another user

Examples

>>> import civis
>>> client = civis.APIClient()
>>> client.projects.list(...)

delete_parent_projects(id: int, parent_project_id: int) → Response

Remove an item from a Parent Project

Parameters:

idint: The ID of the item.
parent_project_idint: The ID of the Parent Project.

Returns:

None: Response code 204: success

delete_shares_groups(id: int, group_id: int) → Response

Revoke the permissions a group has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idint: The ID of the group.

Returns:

None: Response code 204: success

delete_shares_users(id: int, user_id: int) → Response

Revoke the permissions a user has on this object

Parameters:

idint: The ID of the resource that is shared.
user_idint: The ID of the user.

Returns:

None: Response code 204: success

get(project_id: int) → Response

Get a detailed view of a project and the objects in it

Parameters:

project_idint

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
tablesList[civis.Response]
- schema : str
- name : str
- row_count : int
- column_count : int
- created_at : str (time)
- updated_at : str (time)
surveysList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
scriptsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
importsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
exportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
modelsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
notebooksList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
servicesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
workflowsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
- last_executioncivis.Response
  
  state : str
  
  updated_at : str (time)
reportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
script_templatesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
filesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- file_name : str
- file_size : int
- expired : bool
enhancementsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
projectsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- description : str
all_objectsList[civis.Response]
- project_id : int
- object_id : int
- object_type : str
- fco_type : str
- sub_type : str
- name : str
- icon : str
- author : str
- updated_at : str (time)
- auto_share : bool
- archivedstr
  The archival status of the requested item(s).
- hiddenbool
  The hidden status of the item.
- my_permission_levelstr
  Your permission level on the object. One of “read”, “write”, or “manage”.
note : str
can_current_user_enable_auto_sharebool
A flag for if the current user can enable auto-sharing mode for this project.
hiddenbool
The hidden status of the item.
archivedstr
The archival status of the requested item(s).
parent_projectcivis.Response
- idint
  The parent project’s ID.
- nameint
  The parent project’s name.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.

list(*, permission: str = None, auto_share: bool = None, author: str = None, hidden: bool = None, archived: str = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List projects

Parameters:

permissionstr, optional: A permissions string, one of “read”, “write”, or “manage”. Lists only projects for which the current user has that permission.
auto_sharebool, optional: Used to filter projects based on whether the project is autoshare enabled or not.
authorstr, optional: If specified, return items from any of these authors. It accepts a comma- separated list of user IDs.
hiddenbool, optional: If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.
archivedstr, optional: The archival status of the requested item(s).
limitint, optional: Number of results to return. Defaults to 20. Maximum allowed is 1000.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
archivedstr
The archival status of the requested item(s).

list_dependencies(id: int, *, user_id: int = None) → Response

List dependent objects for this object

Parameters:

idint: The ID of the resource that is shared.
user_idint, optional: ID of target user

Returns:

civis.Response

object_typestr
Dependent object type
fco_typestr
Human readable dependent object type
idint
Dependent object ID
namestr
Dependent object name, or nil if the requesting user cannot read this object
permission_levelstr
Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
descriptionstr
Additional information about the dependency, if relevant
shareablebool
Whether or not the requesting user can share this object.

list_parent_projects(id: int, *, hidden: bool = None) → Response

List the Parent Projects an item belongs to

Parameters:

idint: The ID of the item.
hiddenbool, optional: If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
archivedstr
The archival status of the requested item(s).

list_shares(id: int) → Response

List users and groups permissioned on this object

Parameters:

idint: The ID of the resource that is shared.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

post(name: str, description: str, *, note: str = None, auto_share: bool = None, hidden: bool = None) → Response

Create a project

Parameters:

namestr: The name of this project.
descriptionstr: A description of the project.
notestr, optional: Notes for the project.
auto_sharebool, optional: If true, objects within the project will be automatically shared when the project is shared or objects are added.
hiddenbool, optional: The hidden status of the item.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
tablesList[civis.Response]
- schema : str
- name : str
- row_count : int
- column_count : int
- created_at : str (time)
- updated_at : str (time)
surveysList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
scriptsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
importsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
exportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
modelsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
notebooksList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
servicesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
workflowsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
- last_executioncivis.Response
  
  state : str
  
  updated_at : str (time)
reportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
script_templatesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
filesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- file_name : str
- file_size : int
- expired : bool
enhancementsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
projectsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- description : str
all_objectsList[civis.Response]
- project_id : int
- object_id : int
- object_type : str
- fco_type : str
- sub_type : str
- name : str
- icon : str
- author : str
- updated_at : str (time)
- auto_share : bool
- archivedstr
  The archival status of the requested item(s).
- hiddenbool
  The hidden status of the item.
- my_permission_levelstr
  Your permission level on the object. One of “read”, “write”, or “manage”.
note : str
can_current_user_enable_auto_sharebool
A flag for if the current user can enable auto-sharing mode for this project.
hiddenbool
The hidden status of the item.
archivedstr
The archival status of the requested item(s).
parent_projectcivis.Response
- idint
  The parent project’s ID.
- nameint
  The parent project’s name.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.

post_clone(id: int, *, clone_schedule: bool = None, clone_notifications: bool = None) → Response

Clone this

Parameters:

idint: The ID for this project.
clone_schedulebool, optional: If true, also copy the schedule for all applicable project objects.
clone_notificationsbool, optional: If true, also copy the notifications for all applicable project objects.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
tablesList[civis.Response]
- schema : str
- name : str
- row_count : int
- column_count : int
- created_at : str (time)
- updated_at : str (time)
surveysList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
scriptsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
importsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
exportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
modelsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
notebooksList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
servicesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
workflowsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
- last_executioncivis.Response
  
  state : str
  
  updated_at : str (time)
reportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
script_templatesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
filesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- file_name : str
- file_size : int
- expired : bool
enhancementsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
projectsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- description : str
all_objectsList[civis.Response]
- project_id : int
- object_id : int
- object_type : str
- fco_type : str
- sub_type : str
- name : str
- icon : str
- author : str
- updated_at : str (time)
- auto_share : bool
- archivedstr
  The archival status of the requested item(s).
- hiddenbool
  The hidden status of the item.
- my_permission_levelstr
  Your permission level on the object. One of “read”, “write”, or “manage”.
note : str
can_current_user_enable_auto_sharebool
A flag for if the current user can enable auto-sharing mode for this project.
hiddenbool
The hidden status of the item.
archivedstr
The archival status of the requested item(s).
parent_projectcivis.Response
- idint
  The parent project’s ID.
- nameint
  The parent project’s name.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.

put(project_id: int, *, name: str = None, description: str = None, note: str = None) → Response

Update a project

Parameters:

project_idint
namestr, optional: The name of this project.
descriptionstr, optional: A description of the project.
notestr, optional: Notes for the project.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
tablesList[civis.Response]
- schema : str
- name : str
- row_count : int
- column_count : int
- created_at : str (time)
- updated_at : str (time)
surveysList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
scriptsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
importsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
exportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
modelsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
notebooksList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
servicesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
workflowsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
- last_executioncivis.Response
  
  state : str
  
  updated_at : str (time)
reportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
script_templatesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
filesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- file_name : str
- file_size : int
- expired : bool
enhancementsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
projectsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- description : str
all_objectsList[civis.Response]
- project_id : int
- object_id : int
- object_type : str
- fco_type : str
- sub_type : str
- name : str
- icon : str
- author : str
- updated_at : str (time)
- auto_share : bool
- archivedstr
  The archival status of the requested item(s).
- hiddenbool
  The hidden status of the item.
- my_permission_levelstr
  Your permission level on the object. One of “read”, “write”, or “manage”.
note : str
can_current_user_enable_auto_sharebool
A flag for if the current user can enable auto-sharing mode for this project.
hiddenbool
The hidden status of the item.
archivedstr
The archival status of the requested item(s).
parent_projectcivis.Response
- idint
  The parent project’s ID.
- nameint
  The parent project’s name.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.

put_archive(id: int, status: bool) → Response

Update the archive status of this object

Parameters:

idint: The ID of the object.
statusbool: The desired archived status of the object.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
tablesList[civis.Response]
- schema : str
- name : str
- row_count : int
- column_count : int
- created_at : str (time)
- updated_at : str (time)
surveysList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
scriptsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
importsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
exportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
modelsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
notebooksList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
servicesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
workflowsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
- last_executioncivis.Response
  
  state : str
  
  updated_at : str (time)
reportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
script_templatesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
filesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- file_name : str
- file_size : int
- expired : bool
enhancementsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
projectsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- description : str
all_objectsList[civis.Response]
- project_id : int
- object_id : int
- object_type : str
- fco_type : str
- sub_type : str
- name : str
- icon : str
- author : str
- updated_at : str (time)
- auto_share : bool
- archivedstr
  The archival status of the requested item(s).
- hiddenbool
  The hidden status of the item.
- my_permission_levelstr
  Your permission level on the object. One of “read”, “write”, or “manage”.
note : str
can_current_user_enable_auto_sharebool
A flag for if the current user can enable auto-sharing mode for this project.
hiddenbool
The hidden status of the item.
archivedstr
The archival status of the requested item(s).
parent_projectcivis.Response
- idint
  The parent project’s ID.
- nameint
  The parent project’s name.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.

put_auto_share(project_id: int, auto_share: bool) → Response

Enable or disable Auto-Share on a project

Parameters:

project_idint
auto_sharebool: A toggle for sharing the objects within the project when the project is shared or objects are added.

Returns:

civis.Response

idint
The ID for this project.
authorcivis.Response
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
namestr
The name of this project.
descriptionstr
A description of the project.
usersList[civis.Response]
Users who can see the project.
- idint
  The ID of this user.
- namestr
  This user’s name.
- usernamestr
  This user’s username.
- initialsstr
  This user’s initials.
- onlinebool
  Whether this user is online.
auto_share : bool
created_at : str (time)
updated_at : str (time)
tablesList[civis.Response]
- schema : str
- name : str
- row_count : int
- column_count : int
- created_at : str (time)
- updated_at : str (time)
surveysList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
scriptsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
importsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
exportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- type : str
- finished_at : str (time)
- state : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
modelsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
notebooksList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
servicesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- current_deployment_id : int
- last_deploycivis.Response
  
  state : str
  
  updated_at : str (time)
workflowsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
- last_executioncivis.Response
  
  state : str
  
  updated_at : str (time)
reportsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- state : str
script_templatesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
filesList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- file_name : str
- file_size : int
- expired : bool
enhancementsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- last_runcivis.Response
  
  state : str
  
  updated_at : str (time)
projectsList[civis.Response]
- idint
  The item’s ID.
- created_at : str (time)
- updated_at : str (time)
- name : str
- description : str
all_objectsList[civis.Response]
- project_id : int
- object_id : int
- object_type : str
- fco_type : str
- sub_type : str
- name : str
- icon : str
- author : str
- updated_at : str (time)
- auto_share : bool
- archivedstr
  The archival status of the requested item(s).
- hiddenbool
  The hidden status of the item.
- my_permission_levelstr
  Your permission level on the object. One of “read”, “write”, or “manage”.
note : str
can_current_user_enable_auto_sharebool
A flag for if the current user can enable auto-sharing mode for this project.
hiddenbool
The hidden status of the item.
archivedstr
The archival status of the requested item(s).
parent_projectcivis.Response
- idint
  The parent project’s ID.
- nameint
  The parent project’s name.
my_permission_levelstr
Your permission level on the object. One of “read”, “write”, or “manage”.

put_parent_projects(id: int, parent_project_id: int) → Response

Add an item to a Parent Project

Parameters:

idint: The ID of the item.
parent_project_idint: The ID of the Parent Project.

Returns:

None: Response code 204: success

put_shares_groups(id: int, group_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions groups has on this object

Parameters:

idint: The ID of the resource that is shared.
group_idsList[int]: An array of one or more group IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_shares_users(id: int, user_ids: List[int], permission_level: str, *, share_email_body: str = None, send_shared_email: bool = None) → Response

Set the permissions users have on this object

Parameters:

idint: The ID of the resource that is shared.
user_idsList[int]: An array of one or more user IDs.
permission_levelstr: Options are: “read”, “write”, or “manage”.
share_email_bodystr, optional: Custom body text for e-mail sent on a share.
send_shared_emailbool, optional: Send email to the recipients of a share.

Returns:

civis.Response

readerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
writerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
ownerscivis.Response
- usersList[civis.Response]
  
  id : int
  
  name : str
- groupsList[civis.Response]
  
  id : int
  
  name : str
total_user_sharesint
For owners, the number of total users shared. For writers and readers, the number of visible users shared.
total_group_sharesint
For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.

put_transfer(id: int, user_id: int, include_dependencies: bool, *, email_body: str = None, send_email: bool = None) → Response

Transfer ownership of this object to another user

Parameters:

idint: The ID of the resource that is shared.
user_idint: ID of target user
include_dependenciesbool: Whether or not to give manage permissions on all dependencies
email_bodystr, optional: Custom body text for e-mail sent on transfer.
send_emailbool, optional: Send email to the target user of the transfer?

Returns:

civis.Response

dependenciesList[civis.Response]
Dependent objects for this object
- object_typestr
  Dependent object type
- fco_typestr
  Human readable dependent object type
- idint
  Dependent object ID
- namestr
  Dependent object name, or nil if the requesting user cannot read this object
- permission_levelstr
  Permission level of target user (not user’s groups) for dependent object. Null if no target user or not shareable (e.g. a database table).
- descriptionstr
  Additional information about the dependency, if relevant
- sharedbool
  Whether dependent object was successfully shared with target user