Codebase API Documentation

Discussions in Codebase allow you do discuss project specific issues with other members of your team.

API URLs

Object Properties

The XML output below shows the properties which are returned by default when accessing ticket details.

GET /project/discussions

<discussion>
  <id type="integer">1234</id>
  <subject>Secret Web Scale Sauce</subject>
  <permalink>secret-web-scale-sauce</permalink>
  <last-post-at type="datetime">2012-01-30T12:01:14+00:00</last-post-at>
  <user-id type="integer">1</user-id>
  <category-id type="integer">38</category-id>
  <category>General</category>
</discussion>

• id the unique ID for this discussion
• subject the subject for this discussion
• permalink a URL friendly version of the subject
• last-post-at the time the last post was added to this discussion
• user-id the ID of the user that created the discussion
• category-id the ID of the discussion category
• category the name of the discussion category

GET /project/discussions/categories

<discussion-category>
  <id type="integer">38</id>
  <name>General</name>
</discussion-category>

• id the unique ID for this discussion category
• name the name of this discussion category

 GET /project/discussions/discussion-permalink/posts

<discussion-post>
  <content>Hello</content>
  <user-id type="integer">1</user-id>
  <created-at type="datetime">2012-01-30T11:59:02+00:00</created-at>
</discussion-post>

• content the body of the discussion post
• user-id the user who added this post
• created-at the time when this post was added to the discussion

Creating a new discussion

When creating a new discussion, you should simply send the subject, content and category_id fields. The user ID will be automatically based on your API key.

Adding a new post

To add a new post you only need to send the content field.