client.projects.put_archive

A method of the Projects endpoint.

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

Update the archive status of this object

API URL: PUT /projects/{id}/archive

import civis
client = civis.APIClient()
response = client.projects.put_archive(...)

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
- archivedbool
  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.
archivedbool
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”.