This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Skip to end of metadata
  • Created by Former user, last modified by Former user on Dec 13, 2017
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

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.

OperationDescription

createProject

Creates a project.

getProjectRetrieves a project.
listProjectsLists projects.
updateProjectUpdates a project.

Operation details

This section provides details on the operations.

Creating a project

The createProject operation creates a new project. 

createProject
<basecamp.createProject>
	<name>{$ctx:name}</name>
    <description>{$ctx:description}</description>
</basecamp.createProject> 
Properties
  • name: The name of the project to be created.
  • description: The description of the project being created.
Sample request

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

Sample Request for createProject
{
	"apiUrl":"https://3.basecampapi.com",    	 	
	"accessToken":"BAhbByIBsHsidmVyc2lvbiI6MSwidXNlcl9pZHMiOlsyMTDg13LTA0VDA3OjM2OjMxWiJ9dToJVGltZQ2HmBzAqS77kQ==--1fb2c32e4d904b7960b77d5e81db7c6666dee01c2",
    "accountId":"2669154",
	"name":"ProjectName",
	"description":"This is a sample Project"
}
Related Basecamp documentation

https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#create-a-project

Retrieving a project

The getProject operation returns a specified project.

getProject
<basecamp.getProject>        
	<projectId>{$ctx:projectId}</projectId>
</basecamp.getProject> 
Properties
  • projectId: Project ID associated with the project(You can find the projectId in basecamp URL, When click a created project in basecamp. The URL is structured like :https://3.basecamp.com/<accountId>/projects/<projectId>).
Sample request

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

Sample Request for getProject
{
	"apiUrl":"https://3.basecampapi.com",    	 	
	"accessToken":"BAhbByIBsHsidmVyc2lvbiI6MSwidXNlcl9pZHMiOlsyMTDg13LTA0VDA3OjM2OjMxWiJ9dToJVGltZQ2HmBzAqS77kQ==--1fb2c32e4d904b7960b77d5e81db7c6666dee01c2",
    "accountId":"2669154",
	"projectId":"6225303"
} 
Related Basecamp documentation

https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#get-a-project

Listing projects

The listProjects operation returns all active/archived projects.

listProjects
<basecamp.listProjects>
	<isArchived>{$ctx:isArchived}</isArchived>
</basecamp.listProjects>
Properties
  • isArchived: Whether to return the archived projects (default is false).
Sample request

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

Sample Request for listProjects
{
	"apiUrl":"https://3.basecampapi.com",    	 	
	"accessToken":"BAhbByIBsHsidmVyc2lvbiI6MSwidXNlcl9pZHMiOlsyMTDg13LTA0VDA3OjM2OjMxWiJ9dToJVGltZQ2HmBzAqS77kQ==--1fb2c32e4d904b7960b77d5e81db7c6666dee01c2",
    "accountId":"2669154",
	"isArchived":"false"
} 
Related Basecamp documentation

https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#get-projects

Updating a project

The updateProject operation allows updating a project's name and description.

updateProject
<basecamp.updateProject>
    <projectId>{$ctx:projectId}</projectId>
    <name>{$ctx:name}</name>
    <description>{$ctx:description}</description>
</basecamp.updateProject>
Properties
  • projectId: Project ID associated with the project(You can find the projectId in basecamp URL, When click a created project in basecamp. The URL is structured like :https://3.basecamp.com/<accountId>/projects/<projectId>).
  • name: The name of the project to be created.
  • description: The description of the project being created.
Sample request

Following is a sample REST request that can be handled by the updateProject operation.

Sample Request for updateProject
{
	"apiUrl":"https://3.basecampapi.com",    	 	
	"accessToken":"BAhbByIBsHsidmVyc2lvbiI6MSwidXNlcl9pZHMiOlsyMTDg13LTA0VDA3OjM2OjMxWiJ9dToJVGltZQ2HmBzAqS77kQ==--1fb2c32e4d904b7960b77d5e81db7c6666dee01c2",
    "accountId":"2669154",
	"projectId":"6225303",
	"name":"Update ProjectName",
	"description":"Update sample Project"
} 
Related Basecamp documentation

https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#update-a-project

Sample configuration

Following is a sample proxy service that illustrates how to connect to Basecamp 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="basecamp_createProject" transports="https,http" statistics="disable" trace="disable" startOnLoad="true">
  <target>
    <inSequence>
	  <property name="apiUrl" expression="json-eval($.apiUrl)"/>
      <property name="accessToken" expression="json-eval($.accessToken)"/>
	  <property name="accountId" expression="json-eval($.accountId)"/> 
      <property name="name" expression="json-eval($.name)"/>
      <property name="description" expression="json-eval($.description)"/>
	  <basecamp.init>
        <accessToken>{$ctx:accessToken}</accessToken>
        <apiUrl>{$ctx:apiUrl}</apiUrl>
		<accountId>{$ctx:accountId}</accountId>
      </basecamp.init>	  
      <basecamp.createProject>
        <name>{$ctx:name}</name>
        <description>{$ctx:description}</description>
      </basecamp.createProject>
	  <respond/>
    </inSequence>
    <outSequence>
      <send/>
  </target>
</proxy> 
  • No labels