Working with Projects in ActiveCollab

Overview

The following operations allow you to work with projects. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with projects, see Sample configuration.

Operation	Description
getProject	Retrieves details of a project.
listProjects	Retrieves details of all projects.
createProject	Creates a new project.
renameProject	Renames an existing project.
listCurrencies	Retrieves details of all currencies.
listCompletedProjects	Retrieves details of all completed project.
completeProject	Completes a project.
listProjectNames	Lists all existing name of the project.

Operation details

This section provides further details on the operations related to projects.

Retrieving a project details

The getProject operation retrieves details of a particular project.

getProject

<activecollab.getProject>
    <projectId>{$ctx:projectId}</projectId>
</activecollab.getProject>

Properties

projectId: Required - The ID of the project.

Sample request

Following is a sample REST/JSON request that can be handled by the getProject operation.

Sample Request for getProject

{   
    "email":"emailId@gmail.com",
    "password":"1234",
    "apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false",
    "projectId":"10"
}

Retrieving details of all projects

The listProjects operation Retrieves details of all projects.

listProjects

<activecollab.listProjects/>

Sample request

Following is a sample REST/JSON request that can be handled by the listProjects operation.

Sample Request for listProjects

{   
    "email":"emailId@gmail.com",
    "password":"1234",
    "apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false"
}

Creating a new project

The createProject operation adds a new project.

createProject

<activecollab.createProject>
    <companyId>{$ctx:companyId}</companyId>
    <name>{$ctx:name}</name>
    <leaderId>{$ctx:leaderId}</leaderId>
    <categoryId>{$ctx:categoryId}</categoryId>
    <members>{$ctx:members}</members>
</activecollab.createProject>

Properties

name:Required- The project name.
companyId: The ID of the client company that you are working for on this project.
leaderId: The ID of the user who is the Project Leader.
members: The list of IDs of the members for this project.
categoryId: The ID of the project category.

Sample request

Following is a sample REST/JSON request that can be handled by the createProject operation.

Sample Request for createProject

{   
    "email":"emailId@gmail.com",
    "password":"1234",
    "apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false",
    "name":"New project",
    "categoryId":"10",
    "leaderId":"1",
    "companyId":"13",
    "members":[
        2,
        3
    ]
}

Renaming an existing Project

The renameProject operation renames a project.

renameProject

<activecollab.renameProject>
    <name>{$ctx:name}</name>
    <projectId>{$ctx:projectId}</projectId>
</activecollab.renameProject>

Properties

projectId: Required- The ID of the project to be renamed.
name: Required- The new name of that project.

Sample request

Following is a sample REST/JSON request that can be handled by the renameProject operation.

Sample Request for renameProject

{   
    "email":"emailId@gmail.com",
    "password":"1234",
    "apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false",
    "projectId":"10",
    "name":"New Name"
}

Retrieving details of currencies

The listCurrencies operation retrieves details of all currencies.

listCurrencies

<activecollab.listCurrencies/>

Sample request

Following is a sample REST/JSON request that can be handled by the listCurrencies operation.

Sample Request for listCurrencies

{   
    "email":"emailId@gmail.com",
    "password":"1234",
    "apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false"
}

Retrieving details of all completed projects

The listCompletedProjects operation retrieves details of all completed projects.

listCompletedProjects

<activecollab.listCompletedProjects/>

Sample request

Following is a sample REST/JSON request that can be handled by the listCompletedProjects operation.

Sample Request for listCompletedProjects

 {   
    "email":"emailId@gmail.com",
    "password":"1234",
    "apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false"
}

completing a project

The completeProject operation completes details of all completed projects.

completeproject

<activecollab.completeProject>
    <projectId>{$ctx:projectId}</projectId>
</activecollab.completeProject>

Properties

projectId: Required - The ID of the project that needs to be completed.

Sample request

Following is a sample REST/JSON request that can be handled by the completeProject operation.

Sample Request for completeProject

 {   
    "email":"emailId@gmail.com",
    "password":"1234",
    "apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false",
    "projectId":"10"
}

Retrieving all projects name

The listProjectNames operation completes details of all completed projects.

listProjectNames

<activecollab.listProjectNames/>

Sample request

Following is a sample REST/JSON request that can be handled by the listProjectNames operation.

Sample Request for listProjectNames

{   
    "email":"emailId@gmail.com",
    "password":"1234",
    "apiVersion":"v1",
    "clientVendor":"XYZ",
    "clientName":"ABC",
    "blocking":"false"
}

Sample configuration

Following is a sample proxy service that illustrates how to connect to ActiveCollab with the init operation and use the createProject operation. The sample request for this proxy can be found in createProject sample request. You can use this sample as a template for using other operations in this category.

Sample Proxy

<proxy xmlns="http://ws.apache.org/ns/synapse"       
       name="activecollab_createProject"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence>
         <property name="email" expression="json-eval($.email)"/>
         <property name="password" expression="json-eval($.password)"/>
         <property name="apiVersion" expression="json-eval($.apiVersion)"/>
         <property name="clientVendor" expression="json-eval($.clientVendor)"/>
         <property name="clientName" expression="json-eval($.clientName)"/>
         <property name="name" expression="json-eval($.name)"/>
         <property name="leaderId" expression="json-eval($.leaderId)"/>
         <property name="categoryId" expression="json-eval($.categoryId)"/>
         <property name="members" expression="json-eval($.members)"/>
         <property name="companyId" expression="json-eval($.companyId)"/>
         <activecollab.init>   
            <email>{$ctx:email}</email>    
            <password>{$ctx:password}</password>
            <apiVersion>{$ctx:apiVersion}</apiVersion>
            <clientVendor>{$ctx:clientVendor}</clientVendor>
            <clientName>{$ctx:clientName}</clientName>
            <blocking>{$ctx:blocking}</blocking>
         </activecollab.init>
         <activecollab.createProject>
            <companyId>{$ctx:companyId}</companyId>
            <name>{$ctx:name}</name>
            <leaderId>{$ctx:leaderId}</leaderId>
            <categoryId>{$ctx:categoryId}</categoryId>
            <members>{$ctx:members}</members>
         </activecollab.createProject>
         <respond/>
      </inSequence>
   </target>
   <description/>
</proxy>