This is the newer, REST-based version of this API. If you are maintaining an older application, it might be using the legacy, non-RESTful version of this API, which can be found documented here.
Returns all accessible projects. This includes active, inactive, and archived projects.
<projects>
<project>
...
</project>
<project>
...
</project>
...
</projects>
Returns a count of all projects, by project status. If there are no projects with a particular status, that status entry will be omitted from the report.
<count>
<active type="integer">5</active>
<on-hold type="integer">2</active>
<archived type="integer">11</active>
</count>
Returns a single project identified by its integer ID
<project>
<name>Design Review</name>
...
<company>
<name>Globex Corporation</name>
...
</company>
</project>
Creates a new project with the given name.
<request>
<project>
<name>Shopping Cart Redesign</name>
</project>
</request>
Returns status code 201 (Created) on success with the Location header set to the URL for the new project. You can extract the ID of the project from the URL. Failed requests will receive a 422 (Unprocessable Entity) or 500 (Server Error) status code in the response.
Updates attributes of the given project. Only administrative users may update project records. You only need to provide the attributes you wish to update; others ought to be omitted from the request.
<project>
<name type="string">Shopping Cart Redesign</name>
<start-page type="string">log|all|todos|milestones|files</start-page>
<status>active|on-hold|archived</status>
<company-id>#{client-id}</company-id>
<show-writeboards>true|false</show-writeboards>
<announcement>...</announcement>
<show-announcement>true|false</show-announcement>
</project>
Response with “200 OK” on success. Otherwise, returns an error code (e.g. 422 or 403), possibly including a payload describing the error.