Working with Tickets

1. Ticket Fields

  1. name (string) - Ticket summary. A value for this field is required when a Ticket is created;
  2. body (text) - Full ticket description;
  3. tags (string) - List of comma-separated object tags;
  4. visibility (integer) - Object visibility. 0 is private and 1 is normal visibility;
  5. priority (integer) - Priority can have one of five integer values, ranging from -2 (lowest) to 2 (highest). 0 is normal;
  6. due_on (date) - Ticket due date;
  7. assignees (array) - Array of people assigned to the Ticket. The first element of the array is a list of assignees (as an array). Second parameter is an ID of the person responsible for the Ticket (ID must be in the first list);
  8. milestone_id (integer) - ID of the parent milestone;
  9. parent_id (integer) - ID of the parent object (category, ticket for tasks etc.);
  10. ticket_id (integer) - Ticket's unique ID in the project.

2. /projects/:project_id/tickets

Lists all active tickets in a project.

Method: GET

<tickets>
  <ticket>
    <id>9</id>
    <type>
      <![CDATA[Ticket]]>
    </type>
    <name>
      <![CDATA[Updated summary]]>
    </name>
    <body>...</body>
    <state>...</state>
    <visibility>...</visibility>
    <created_on>...</created_on>
    <created_by_id>...</created_by_id>
    <updated_on>...</updated_on>
    <updated_by_id>...</updated_by_id>
    <version>...</version>
    <permalink>...</permalink>
    <priority>...</priority>
    <due_on>...</due_on>
    <completed_on>...</completed_on>
    <completed_by_id>...</completed_by_id>
    <project_id>...</project_id>
    <parent_id>...</parent_id>
    <milestone_id>...</milestone_id>
    <permissions>
      <can_edit>1</can_edit>
      <can_delete>1</can_delete>
      <can_change_visibility>1</can_change_visibility>
      <can_move>1</can_move>
      <can_copy>1</can_copy>
      <can_change_complete_status>1</can_change_complete_status>
    </permissions>
    <ticket_id>1</ticket_id>
  </ticket>
</tickets>

3. /projects/:project_id/tickets/archive

Displays all completed tickets in a project.

Method: GET

<tickets>
  <ticket>
    <id>9</id>
    <type>
      <![CDATA[Ticket]]>
    </type>
    <name>
      <![CDATA[Updated summary]]>
    </name>
    <body>...</body>
    <state>...</state>
    <visibility>...</visibility>
    <created_on>...</created_on>
    <created_by_id>...</created_by_id>
    <updated_on>...</updated_on>
    <updated_by_id>...</updated_by_id>
    <version>...</version>
    <permalink>...</permalink>
    <priority>...</priority>
    <due_on>...</due_on>
    <completed_on>...</completed_on>
    <completed_by_id>...</completed_by_id>
    <project_id>...</project_id>
    <parent_id>...</parent_id>
    <milestone_id>...</milestone_id>
    <permissions>
      <can_edit>1</can_edit>
      <can_delete>1</can_delete>
      <can_change_visibility>1</can_change_visibility>
      <can_move>1</can_move>
      <can_copy>1</can_copy>
      <can_change_complete_status>1</can_change_complete_status>
    </permissions>
    <ticket_id>1</ticket_id>
  </ticket>
</tickets>

4. /projects/:project_id/tickets/add

Creates a new ticket for the project.

Method: POST.

Request example:

submitted = submitted
ticket[name] = This is summary

Response:

<ticket>
  <id>19</id>
  <type>
    <![CDATA[Ticket]]>
  </type>
  <name>
    <![CDATA[This is summary]]>
  </name>
  <body>...</body>
  <state>...</state>
  <visibility>...</visibility>
  <created_on>...</created_on>
  <created_by_id>...</created_by_id>
  <updated_on>...</updated_on>
  <updated_by_id>...</updated_by_id>
  <version>...</version>
  <permalink>...</permalink>
  <priority>...</priority>
  <due_on>...</due_on>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <milestone_id>...</milestone_id>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>1</can_move>
    <can_copy>1</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
  <ticket_id>2</ticket_id>
</ticket>

5. /projects/:project_id/tickets/:ticket_id

Displays ticket details.

Method: GET

Note

When you are making a request, please use the ticket ID for that particular project, not the project object ID.

<ticket>
  <id>9</id>
  <type>
    <![CDATA[Ticket]]>
  </type>
  <name>
    <![CDATA[My ticket]]>
  </name>
  <body>...</body>
  <state>...</state>
  <visibility>...</visibility>
  <created_on>...</created_on>
  <created_by_id>...</created_by_id>
  <updated_on>...</updated_on>
  <updated_by_id>...</updated_by_id>
  <version>...</version>
  <permalink>...</permalink>
  <priority>...</priority>
  <due_on>...</due_on>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <milestone_id>...</milestone_id>
  <comments>
    ...
  </comments>
  <tasks>
    ...
  </tasks>
  <attachments>
    ...
  </attachments>
  <assignees>
    ...
  </assignees>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>1</can_move>
    <can_copy>1</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
  <ticket_id>1</ticket_id>
</ticket>

6. /projects/:project_id/tickets/:ticket_id/edit

Updates properties of the existing ticket.

Method: POST.

Note

When you are making a request, please use the ticket ID for that particular project, not the project object ID.

Reqest example:

submitted = submitted
ticket[name] = Updated summary

Response:

<ticket>
  <id>9</id>
  <type>
    <![CDATA[Ticket]]>
  </type>
  <name>
    <![CDATA[Updated summary]]>
  </name>
  <body>...</body>
  <state>...</state>
  <visibility>...</visibility>
  <created_on>...</created_on>
  <created_by_id>...</created_by_id>
  <updated_on>...</updated_on>
  <updated_by_id>...</updated_by_id>
  <version>...</version>
  <permalink>
    <![CDATA[http://localhost/corporate_12/public/index.php?path_info=projects%2F1%2Ftickets%2F1]]>
  </permalink>
  <priority>...</priority>
  <due_on>...</due_on>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <milestone_id>...</milestone_id>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>1</can_move>
    <can_copy>1</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
  <ticket_id>1</ticket_id>
</ticket>