O módulo Tag é responsável pelo gerenciamento das etiquetas utilizadas na plataforma. As tags permitem categorizar, identificar e organizar informações em diferentes processos do sistema, facilitando pesquisas, filtros e a associação de dados entre entidades.

Além da consulta de tags, este módulo disponibiliza endpoints para listar as tags mais utilizadas, realizar pesquisas com filtros e consultar resultados por tipo de tag.

Funcionalidades Principais

Abaixo estão os atalhos para as operações mais utilizadas neste módulo:

Listar Tags Mais Utilizadas
Listar Tags Mais Utilizadas por Tipo
Pesquisar Tags

Listar Tags Mais Utilizadas

Retorna uma lista paginada contendo as tags mais utilizadas na plataforma.

Endpoint: /api/tags/most-used

Método: GET

Parâmetros:

page (query, obrigatório) — Informações de paginação da consulta.

Response body:

{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "string",
      "fromSystem": true,
      "tagType": "string"
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}

Listar Tags Mais Utilizadas por Tipo

Retorna as tags mais utilizadas filtrando pelo tipo informado.

Endpoint: /api/tags/most-used/{tagType}

Método: GET

Parâmetros:

tagType (path, obrigatório) — Tipo da tag que será utilizado no filtro.
page (query, obrigatório) — Informações de paginação da consulta.

Response body:

{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "string",
      "fromSystem": true,
      "tagType": "string"
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}

Pesquisar Tags

Realiza a pesquisa de tags utilizando filtros específicos, retornando uma lista paginada de resultados.

Endpoint: /api/tags/filters

Método: GET

Parâmetros:

tagFilter (query, obrigatório) — Objeto contendo os critérios utilizados na pesquisa.
page (query, obrigatório) — Informações de paginação da consulta.

Response body:

{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "string",
      "fromSystem": true,
      "tagType": "string"
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}