Tickets

>>>

GET /api/v2/tickets
List of tickets

Returns the list of the visible tickets for the user

Examples

GET '/api/v2/tickets':
 [
   {
     "id": 1,
     "title": "first ticket",
     "tags": ["tag1","tag2"],
     "small_summary": "text",
     "content": "text",
     "status": "Planned",
     "user_id": 22,
     "created_at": "2014-05-20T14:41:41+02:00",
     "updated_at": "2014-05-20T14:41:41+02:00"
   },
   {
     "id": 2,
     "title": "second ticket",
     "tags": ["tag1","tag2"],
     "small_summary": "text",
     "content": "text",
     "status": "In Progress",
     "user_id": 24,
     "created_at": "2014-05-20T14:41:41+02:00",
     "updated_at": "2014-05-20T14:41:41+02:00"
   }
 ]
>>>

GET /api/v2/tickets/:id
Get a specific ticket

Returns detailed information about a ticket.

Examples

GET '/api/v2/tickets/2':
 {
   "id": 2,
   "title": "second ticket",
   "tags": ["tag1","tag2"],
   "small_summary": "text",
   "content": "text",
   "status": "In Progress",
   "user_id": 24,
   "created_at": "2014-05-20T14:41:41+02:00",
   "updated_at": "2014-05-20T14:41:41+02:00"
 }
>>>

POST /api/v2/tickets
Create a new ticket

Examples

POST '/api/v2/tickets' -d {
   "ticket": {
     "title": "second ticket",
     "tags": ["tag1","tag2"],
     "small_summary": "text",
     "content": "text",
     "status": "In Progress"
   },
   "restricted_accounts": ["account_name_1", "account_name_2"]
 }

Params

Param name Description
title
required

The title of the ticket

Validations:

  • Must be a String
tags
required

The tags for the ticket

Validations:

  • Must be an array of any type
small_summary
required

The summary of the ticket

Validations:

  • Must be a String
content
required

The content of the ticket

Validations:

  • Must be a String
status
optional

The status of the ticket: should be opened or pending

Validations:

  • Must be a String
restricted_accounts
optional

The names of the accounts when the ticket has restricted accounts

Validations:

  • Must be an array of any type
>>>

PUT /api/v2/tickets/:id
Update ticket

Update the ticket’s informations

Examples

PUT '/api/v2/tickets/2':
 {
   "ticket": {
     "title": "second ticket",
     "tags": ["tag1","tag2"],
     "small_summary": "text",
     "content": "text",
     "status": "In Progress"
   }
 }

Params

Param name Description
title
required

The title of the ticket

Validations:

  • Must be a String
tags
required

The tags for the ticket

Validations:

  • Must be an array of any type
small_summary
required

The summary of the ticket

Validations:

  • Must be a String
content
required

The content of the ticket

Validations:

  • Must be a String
status
required

The status of the ticket: should be opened or pending

Validations:

  • Must be a String
user_id
optional

The id of the ticket’s owner

Validations:

  • Must be a Integer
>>>

PUT /api/v2/tickets/:id/close
Close a ticket

Close the ticket and return the informations

Examples

PUT '/api/v2/tickets/:id/close' : {
   "id": 2,
   "title": "second ticket",
   "tags": ["tag1","tag2"],
   "small_summary": "text",
   "content": "text",
   "status": "Closed",
   "user_id": 24,
   "created_at": "2014-05-20T14:41:41+02:00",
   "updated_at": "2014-05-20T14:41:41+02:00"
 }
>>>

DELETE /api/v2/tickets/:id
Delete a ticket

>>>

GET /api/v2/tickets/:id/acks
Get the users with dashboard notification with a specific Ack status for a ticket

Examples

GET '/api/v2/tickets/:id/acks_status' : {
    "ack_status" : "acked" or "not_acked"
  }

Params

Param name Description
ack_status
optional

The ack status to filter users

Validations:

  • Must be a String