Working with Project Groups

Project Group commands let you organise manage project groups from an external application.

Note

The ability to work with project groups through the API was added in activeCollab 1.1.4 and is not available in older versions.

1. Project Group Fields

  1. name (string) - Group name. Value of this field is required and it needs to be unique.

2. projects/groups

Lists all available project groups in your activeCollab.

Method: GET.

Example response:

<project_groups>
  <project_group>
    <id>1</id>
    <name>
      <![CDATA[Default]]>
    </name>
  </project_group>
  <project_group>
    <id>2</id>
    <name>
      <![CDATA[First Group]]>
    </name>
  </project_group>
</project_groups>__

3. projects/groups/add

Creates a new project group. The name of the group needs to be unique.

Method: POST.

Request example:

submitted=submitted
project_group[name] = Development

Response:

<project_group>
  <id>4</id>
  <name>
    <![CDATA[Development]]>
  </name>
</project_group>

4. projects/groups/:project_group_id

Displays group details, including all projects that belong to a group.

Method: GET.

<project_group>
  <id>2</id>
  <name>
    <![CDATA[First Group]]>
  </name>
  <projects>
    <project>
      <id>1</id>
      <name>
        <![CDATA[First Project]]>
      </name>
      <overview>
        <![CDATA[<p>This is overview of the first project</p>]]>
      </overview>
      <status>
        <![CDATA[active]]>
      </status>
      <permalink>...</permalink>
      <leader_id>15</leader_id>
      <company_id>16</company_id>
      <group_id>2</group_id>
    </project>
  </projects>
</project_group>

5. projects/groups/:project_group_id/edit

This command updates the existing project group name.

Method: POST.

Request example:

submitted=submitted
project_group[name] = Update group name

Response:

<project_group>
  <id>2</id>
  <name>
    <![CDATA[Update group name]]>
  </name>
</project_group>

6. projects/groups/:project_group_id/delete

Removes a project group from the database. If successful, the system will return a HTTP status 200 OK message.

Method: POST.

Note

Be aware that only empty project groups can be deleted.

Request example:

submitted=submitted