Codebase API Documentation

Status, priorities and categories all come under the same heading of "property objects". All three can be assigned to tickets using their foreign key, however to do this, you need to know the IDs of the objects within each project. Each project in the system has it's own unique set of objects - a default set is created when the project is made. You can see the defaults below.

At present, you can only get lists of objects from the API and you must have read access to tickets.

API URLs

Status Object

GET /project/tickets/statuses

<ticketing-status>
  <id type="integer">6674</id>
  <name>New</name>
  <background-colour>9ac130</background-colour>
  <order type="integer">1</order>
  <treat-as-closed type="boolean">false</treat-as-closed>
</ticketing-status>

• id the unique ID for this status
• name the name as it will be displayed
• background-colour the hex code to used when displaying in the web interface
• order the order which it should appear in lists
• treat-as-closed does this status imply that a ticket is closed?

Defaults

The items listed below will be created by default when the project is created. These can be adjusted by admin users from the Project Settings page.

• New
• Accepted
• In Progress
• Completed
• Invalid

Priority Object

GET /project/tickets/priorities

<ticketing-priority>
  <id type="integer">3300</id>
  <name>Low</name>
  <colour>666666</colour>
  <default type="boolean">false</default>
  <position type="integer">4</position>
</ticketing-priority>

• id the unique ID for this priority
• name the name as it will be displayed
• colour the foreground colour used when displaying in the web interface.
• default is this the status which should be selected by default in the web interface?
• position the order which it should appear in lists

Defaults

The items listed below will be created by default when the project is created. These can be adjusted by admin users from the Project Settings page.

• Critical
• High
• Normal
• Low

Category Object

GET /project/tickets/categories

<ticketing-category>
  <id type="integer">3351</id>
  <name>Cosmetic</name>
</ticketing-category>

• id the unique ID for this category
• name is the name as it will be displayed

Defaults Objects

The items listed below will be created by default when the project is created. These can be adjusted by admin users from the Project Settings page.

• Cosmetic
• API
• Refactoring
• Security

Type Object

GET /project/tickets/types

<?xml version="1.0" encoding="UTF-8"?>
<ticketing-types type="array">
    <ticketing-type>
        <id type="integer">1904887</id>
        <name>Bug</name>
        <icon>bug</icon>
    </ticketing-type>
    <ticketing-type>
        <id type="integer">1904890</id>
        <name>Enhancement</name>
        <icon>hat</icon>
    </ticketing-type>
    <ticketing-type>
        <id type="integer">1904893</id>
        <name>Feature</name>
        <icon>construction</icon>
    </ticketing-type>
    <ticketing-type>
        <id type="integer">1904896</id>
        <name>Task</name>
        <icon>task</icon>
    </ticketing-type>
</ticketing-types>

Defaults Objects

The items listed below will be created by default when the project is created. These can be adjusted by admin users from the Project Settings page.

• Bug
• Enhancement
• Feature
• Task