Perfil de relatório

INFO

Um perfil de relatório é um filtro/condição salvo e reutilizável para o módulo de relatórios do Zammad. Ele não é uma automação e não faz nada por si só. É uma condição nomeada que aparece como uma visualização selecionável ao gerar relatórios com o recurso de relatórios do Zammad, restrita às funções (role_ids) que podem vê-la.

Compare com os fluxos de trabalho principais, que usam um objeto de condição de formato semelhante, mas não validam os campos referenciados.

Listar

Permissão necessária: admin.report_profile

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

Details

// HTTP-Code 200 OK

[
  {
    "id": 1,
    "name": "-all-",
    "condition": {},
    "active": true,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2026-09-30T07:55:54.147Z",
    "updated_at": "2026-09-30T07:55:54.147Z",
    "role_ids": []
  },
  {
    "id": 2,
    "name": "Open tickets (new or open)",
    "condition": {
      "ticket.state_id": {
        "operator": "is",
        "value": [
          "1",
          "2"
        ]
      }
    },
    "active": true,
    "updated_by_id": 3,
    "created_by_id": 3,
    "created_at": "2026-09-24T12:32:01.918Z",
    "updated_at": "2026-09-24T12:32:01.905Z",
    "role_ids": [
      2,
      1
    ]
  }
]

INFO

A lista retorna o registro completo de cada perfil, com o mesmo conjunto de campos da resposta de Show abaixo. A entrada 1 (-all-) é o perfil padrão integrado ao Zammad.

Mostrar

Permissão necessária: admin.report_profile

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

Details

// HTTP-Code 200 OK

{
  "id": 2,
  "name": "Open tickets (new or open)",
  "condition": {
    "ticket.state_id": {
      "operator": "is",
      "value": [
        "1",
        "2"
      ]
    }
  },
  "active": true,
  "updated_by_id": 3,
  "created_by_id": 3,
  "created_at": "2026-09-24T12:32:01.918Z",
  "updated_at": "2026-09-24T12:32:01.905Z",
  "role_ids": [
    2,
    1
  ]
}

Criar

Permissão necessária: admin.report_profile

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

Details

{
  "name": "Open tickets (new or open)",
  "condition": {
    "ticket.state_id": {
      "operator": "is",
      "value": [
        "1",
        "2"
      ]
    }
  },
  "active": true,
  "role_ids": [
    1,
    2
  ]
}

INFO

Os IDs de funções não são garantidamente os mesmos entre instâncias. Consulte primeiro os IDs das funções de que você precisa pela API de funções em vez de fixá-los no código.

INFO

Diferente dos fluxos de trabalho principais, a condition de um perfil de relatório valida que os campos referenciados são campos de ticket reais e totalmente migrados. Referenciar um campo personalizado que existe, mas cuja migração de schema ainda não terminou (to_create/to_migrate ainda true nesse campo), falha com:

Details

// HTTP-Code 422 Unprocessable Entity

{
  "error": "Invalid object selector conditions",
  "error_human": "Invalid object selector conditions",
  "invalid_attribute": {
    "condition": "Invalid object selector conditions"
  }
}

Atualização

Permissão necessária: admin.report_profile

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

O formato do payload é idêntico ao de Create. A resposta é o registro atualizado, no mesmo formato da resposta de Create.

INFO

Enviar o payload completo de Create para o id de um perfil existente atualiza esse registro no lugar. Não cria uma duplicata.

Details

{
  "name": "Open tickets (new or open)",
  "condition": {
    "ticket.state_id": {
      "operator": "is",
      "value": [
        "1",
        "2"
      ]
    }
  },
  "active": true,
  "role_ids": [
    1,
    2
  ],
  "id": 2
}

Excluir

Permissão necessária: admin.report_profile

DANGER

Esta é uma remoção permanente

Observe que remover perfis de relatório não pode ser desfeito.

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

Details

// HTTP-Code 200 OK

{}