Estados

WARNING

Criar, alterar ou remover estados via os endpoints abaixo não é recomendado! Você pode fazer isso na interface do Zammad. Para isso, vá até a interface de administração em System > Objects > Ticket.

Listar

Permissão necessária: admin.object ou ticket.agent outicket.customer

Solicitação GET enviada: /api/v1/ticket_states

Details

// HTTP-Code 200 OK

[
  {
    "id": 1,
    "state_type_id": 1,
    "name": "new",
    "next_state_id": null,
    "ignore_escalation": false,
    "default_create": true,
    "default_follow_up": false,
    "note": null,
    "active": true,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:51:13.504Z",
    "updated_at": "2021-11-03T11:51:13.520Z"
  },
  {
    "id": 2,
    "state_type_id": 2,
    "name": "open",
    "next_state_id": null,
    "ignore_escalation": false,
    "default_create": false,
    "default_follow_up": true,
    "note": null,
    "active": true,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:51:13.518Z",
    "updated_at": "2021-11-03T11:51:13.518Z"
  },
  {
    "id": 3,
    "state_type_id": 3,
    "name": "pending reminder",
    "next_state_id": null,
    "ignore_escalation": true,
    "default_create": false,
    "default_follow_up": false,
    "note": null,
    "active": true,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:51:13.528Z",
    "updated_at": "2021-11-03T11:51:13.528Z"
  },
  {
    "id": 4,
    "state_type_id": 5,
    "name": "closed",
    "next_state_id": null,
    "ignore_escalation": true,
    "default_create": false,
    "default_follow_up": false,
    "note": null,
    "active": true,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:51:13.535Z",
    "updated_at": "2021-11-03T11:51:13.535Z"
  },
  {
    "id": 5,
    "state_type_id": 6,
    "name": "merged",
    "next_state_id": null,
    "ignore_escalation": true,
    "default_create": false,
    "default_follow_up": false,
    "note": null,
    "active": true,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:51:13.540Z",
    "updated_at": "2021-11-03T11:51:13.540Z"
  },
  {
    "id": 6,
    "state_type_id": 7,
    "name": "removed",
    "next_state_id": null,
    "ignore_escalation": true,
    "default_create": false,
    "default_follow_up": false,
    "note": null,
    "active": false,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:51:13.546Z",
    "updated_at": "2021-11-03T11:51:13.546Z"
  },
  {
    "id": 7,
    "state_type_id": 4,
    "name": "pending close",
    "next_state_id": 4,
    "ignore_escalation": true,
    "default_create": false,
    "default_follow_up": false,
    "note": null,
    "active": true,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:51:13.553Z",
    "updated_at": "2021-11-03T11:51:13.553Z"
  }
]

Mostrar

Permissão necessária: admin.object ou ticket.agent outicket.customer

Solicitação GET enviada: /api/v1/ticket_states/{id}

Details

// HTTP-Code 200 OK

{
  "id": 4,
  "state_type_id": 5,
  "name": "closed",
  "next_state_id": null,
  "ignore_escalation": true,
  "default_create": false,
  "default_follow_up": false,
  "note": null,
  "active": true,
  "updated_by_id": 1,
  "created_by_id": 1,
  "created_at": "2021-11-03T11:51:13.535Z",
  "updated_at": "2021-11-03T11:51:13.535Z"
}

Criar

Permissão necessária: admin.object

Solicitação POST enviada: /api/v1/ticket_states

INFO

O payload abaixo usa state_type_id, que é um conjunto de IDs específico da instância. Os tipos de estado indicam como o estado vai funcionar.

Como não há endpoint para recuperá-los, use o console Rails.

Details

{
  "name": "in progress",
  "state_type_id": 2,
  "ignore_escalation": true,
  "active": true
}

Atualização

Permissão necessária: admin.object

Solicitação PUT enviada: /api/v1/ticket_states/{id}

Details

{
  "note": "State created & updated via API"
}

Excluir

Permissão necessária: admin.object

Solicitação DELETE enviada: /api/v1/ticket_states/{id}

DANGER

Esta é uma remoção permanente

Observe que remover estados de ticket não pode ser desfeito.

Remover estados de ticket com referências em tickets não é possível via API - isso será indicado por "error": "Can't delete, object has references.". Isso não é um bug.

Considere definir esse estado como active: false, ou ajustar todos os tickets com o estado a remover para outro estado.

Details

Response:

// HTTP-Code 200 OK

{}