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 |
|---|---|
Creates a project. | |
| getProject | Retrieves a project. |
| listProjects | Lists projects. |
| updateProject | Updates a project. |
Operation details
This section provides details on the operations.
Creating a project
The createProject operation creates a new project.
<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.
{
"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.
<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.
{
"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.
<basecamp.listProjects>
<status>{$ctx:status}</status>
</basecamp.listProjects>
Properties
status[optional]: when set to archived or trashed, will return archived or trashed projects visible to the current user.
Sample request
Following is a sample REST request that can be handled by the listProjects operation.
{
"apiUrl":"https://3.basecampapi.com",
"accessToken":"BAhbByIBsHsidmVyc2lvbiI6MSwidXNlcl9pZHMiOlsyMTDg13LTA0VDA3OjM2OjMxWiJ9dToJVGltZQ2HmBzAqS77kQ==--1fb2c32e4d904b7960b77d5e81db7c6666dee01c2",
"accountId":"2669154",
"status":"archived"
}
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.
<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.description:The description of the project .
Sample request
Following is a sample REST request that can be handled by the updateProject operation.
{
"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.
<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>