Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

OperationDescription

createProject

Creates a project.

getProjectRetrieves a project.
listProjectsLists projects.
UpdateProjectupdateProjectUpdates a project.

Operation details

...

Code Block
languagexml
titlecreateProject
<basecamp.createProject>
	<name>{$ctx:name}</name>
    <description>{$ctx:description}</description>
</basecamp.createProject> 
Properties
  • name: The name of the project to be created.
  • description[optional]: The description of the project being created.

...

Code Block
languagexml
titlegetProject
<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>).

...

Code Block
languagexml
titlelistProjects
<basecamp.listProjects>
	<isArchived>    <status>{$ctx:isArchivedstatus}</isArchived>status>
</basecamp.listProjects>
Properties
  • isArchived: Whether to return the archived projects (default is false)

    status[optional]: when set to archived or trashed, will return archived or trashed projects visible to the current user.

Anchor
request
request
Sample request

...

Code Block
languagexml
titleSample Request for listProjects
{
	"apiUrl":"https://3.basecampapi.com",    	 	
	"accessToken":"BAhbByIBsHsidmVyc2lvbiI6MSwidXNlcl9pZHMiOlsyMTDg13LTA0VDA3OjM2OjMxWiJ9dToJVGltZQ2HmBzAqS77kQ==--1fb2c32e4d904b7960b77d5e81db7c6666dee01c2",
    "accountId":"2669154",
	"isArchivedstatus":"falsearchived"
} 
Related Basecamp documentation

...

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

Code Block
languagexml
titleupdateProject
<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.

...