Working with Checklists

The commands described in this chapter will enable you to manage Checklists within a project in your edition of activeCollab. Each project has its own separate set of Checklists.

Note

By default, the Checklists module is not installed in activeCollab Corporate edition and these commands are not available. To install it, go to the Administration > Modules page and install it from the list of Available Modules.

1. Checklist Fields

  1. name (string) - Object name or a short one line summary. The value of this field is required when a Checklist is created.;
  2. body (text) - Full checklist description. Use HTML for formatting;
  3. tags (string) - List of comma-separated object tags;
  4. visibility (integer) - Object visibility. 0 is private and 1 is normal visibility;
  5. milestone_id (integer) - ID of parent milestone.

2. /projects/:project_id/checklists

Displays all active Checklists for a given project.

Method: GET.

Example response:

<checklists>
  <checklist>
    <id>13</id>
    <type>
      <![CDATA[Checklist]]>
    </type>
    <name>
      <![CDATA[Updated name]]>
    </name>
    <body>
      <![CDATA[Full description of this checklist]]>
    </body>
    <state>...</state>
    <visibility>...</visibility>
    <created_on>...</created_on>
    <created_by_id>...</created_by_id>
    <updated_on>...</updated_on>
    <updated_by_id>...</updated_by_id>
    <version>...</version>
    <permalink>...</permalink>
    <priority>...</priority>
    <due_on>...</due_on>
    <completed_on>...</completed_on>
    <completed_by_id>...</completed_by_id>
    <project_id>...</project_id>
    <parent_id>...</parent_id>
    <milestone_id>...</milestone_id>
    <permissions>
      <can_edit>1</can_edit>
      <can_delete>1</can_delete>
      <can_change_visibility>1</can_change_visibility>
      <can_move>1</can_move>
      <can_copy>1</can_copy>
      <can_change_complete_status>1</can_change_complete_status>
    </permissions>
  </checklist>
</checklists>

3. /projects/#project_id/checklists/archive

Lists all completed Checklists in the project.

Method: GET.

Example response:

<checklists>
  <checklist>
    <id>13</id>
    <type>
      <![CDATA[Checklist]]>
    </type>
    <name>
      <![CDATA[Updated name]]>
    </name>
    <body>
      <![CDATA[Full description of this checklist]]>
    </body>
    <state>...</state>
    <visibility>...</visibility>
    <created_on>...</created_on>
    <created_by_id>...</created_by_id>
    <updated_on>...</updated_on>
    <updated_by_id>...</updated_by_id>
    <version>...</version>
    <permalink>...</permalink>
    <priority>...</priority>
    <due_on>...</due_on>
    <completed_on>...</completed_on>
    <completed_by_id>...</completed_by_id>
    <project_id>...</project_id>
    <parent_id>...</parent_id>
    <milestone_id>...</milestone_id>
    <permissions>
      <can_edit>1</can_edit>
      <can_delete>1</can_delete>
      <can_change_visibility>1</can_change_visibility>
      <can_move>1</can_move>
      <can_copy>1</can_copy>
      <can_change_complete_status>1</can_change_complete_status>
    </permissions>
  </checklist>
</checklists>

4. /projects/:project_id/checklists/add

This command will create a new checklist.

Method: POST.

Request example:

submitted=submitted
checklist[name] = New checklist
checklist[body] = Full description of this checklist
checklist[visibility] = 1

Response:

<checklist>
  <id>13</id>
  <type>
    <![CDATA[Checklist]]>
  </type>
  <name>
    <![CDATA[New checklist]]>
  </name>
  <body>
    <![CDATA[Full description of this checklist]]>
  </body>
  <state>...</state>
  <visibility>...</visibility>
  <created_on>...</created_on>
  <created_by_id>...</created_by_id>
  <updated_on>...</updated_on>
  <updated_by_id>...</updated_by_id>
  <version>...</version>
  <permalink>...</permalink>
  <priority>...</priority>
  <due_on>...</due_on>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>1</project_id>
  <parent_id>...</parent_id>
  <milestone_id>...</milestone_id>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>1</can_move>
    <can_copy>1</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
</checklist>

5. /projects/:project_id/checklists/:checklist_id

Displays checklist details.

This request also returns array of tasks attached to this checklist in the tasks property.

Method: GET.

Example response:

<checklist>
  <id>13</id>
  <type>
    <![CDATA[Checklist]]>
  </type>
  <name>
    <![CDATA[New checklist]]>
  </name>
  <body>
    <![CDATA[Full description of this checklist]]>
  </body>
  <state>...</state>
  <visibility>...</visibility>
  <created_on>...</created_on>
  <created_by_id>...</created_by_id>
  <updated_on>...</updated_on>
  <updated_by_id>...</updated_by_id>
  <version>...</version>
  <permalink>...</permalink>
  <priority>...</priority>
  <due_on>...</due_on>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <milestone_id>...</milestone_id>
  <tasks>
    ...
  </tasks>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>1</can_move>
    <can_copy>1</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
</checklist>

6. /projects/:project_id/checklists/:checklist_id/edit

Updates the properties of an existing checklist.

Method: POST.

Request example:

submitted=submitted
checklist[name] = Updated name

Response:

<checklist>
  <id>13</id>
  <type>
    <![CDATA[Checklist]]>
  </type>
  <name>
    <![CDATA[Updated name]]>
  </name>
  <body>
    <![CDATA[Full description of this checklist]]>
  </body>
  <state>...</state>
  <visibility>...</visibility>
  <created_on>...</created_on>
  <created_by_id>...</created_by_id>
  <updated_on>...</updated_on>
  <updated_by_id>...</updated_by_id>
  <version>...</version>
  <permalink>...</permalink>
  <priority>...</priority>
  <due_on>...</due_on>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <milestone_id>...</milestone_id>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>1</can_move>
    <can_copy>1</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
</checklist>