A API de Etiquetas do Themis (V2) permite gerenciar o ciclo completo de etiquetas associadas às entidades do sistema, como processos, contratos, solicitações, publicações, desdobramentos e andamentos.
Por meio dela, é possível vincular, desvincular, sobrescrever e consultar etiquetas aplicadas a cada registro, além de realizar filtros e listar as opções disponíveis para cada tipo de entidade.
Esses recursos facilitam a organização e categorização de informações dentro do sistema, permitindo maior controle e flexibilidade na classificação de dados.
A API também oferece endpoints para consulta de etiquetas disponíveis por entidade e para listagem de todas as entidades que suportam o uso de etiquetas, garantindo uma integração mais simples e estruturada com sistemas externos.
Adicionar etiquetas em uma entidade
Path: /api/v2/etiquetas/vinculo
Método: POST
Parâmetros enviados no BODY da requisição
Parâmetro | Tipo | Descrição |
entidade | Integer (obrigatório) | Entidade a ser afetada, deve ser um valor contido na lista de entidades disponíveis para etiquetas. |
idEntidade | Integer (obrigatório) | ID da entidade a ser afetada. |
idsEtiquetas | Integer[] (obrigatório) | IDs das etiquetas a serem vinculadas (cadastradas) na entidade. |
JSON enviado (exemplo):
{
"entidade": 1,
"idEntidade": 441,
"idsEtiquetas": [25]
}
JSON retornado (exemplo):
[
"entidade": 1,
"idEntidade": 441,
"etiquetas":
[
{
"id": 13,
"nome": "Importante",
"color": "#000000",
"backgroundColor": "#ffff00"
},
{
"id": 2,
"nome": "Cadastro",
"color": "#000000",
"backgroundColor": "#ff6562"
},
{
"id": 25,
"nome": "Em andamento",
"color": "#000000",
"backgroundColor": "#95ff95"
}
]
]
Remover etiquetas de uma entidade
Path: /api/v2/etiquetas/desvinculo
Método: DELETE
Parâmetros enviados no BODY da requisição
Parâmetro | Tipo | Descrição |
entidade | Integer (obrigatório) | Entidade a ser afetada, deve ser um valor contido na lista de entidades disponíveis para etiquetas. |
idEntidade | Integer (obrigatório) | ID da entidade a ser afetada. |
idsEtiquetas | Integer[] (obrigatório) | IDs das etiquetas a serem desvinculadas (removidas) da entidade. |
JSON enviado (exemplo):
{
"entidade": 1,
"idEntidade": 441,
"idsEtiquetas": [25]
}
JSON retornado (exemplo):
[
"entidade": 1,
"idEntidade": 441,
"etiquetas":
[
{
"id": 13,
"nome": "Importante",
"color": "#000000",
"backgroundColor": "#ffff00"
},
{
"id": 2,
"nome": "Cadastro",
"color": "#000000",
"backgroundColor": "#ff6562"
}
]
]
Sobreescrever todas as etiquetas de uma entidade
Path: /api/v2/etiquetas/atualizacao
Método: PUT
Parâmetros enviados no BODY da requisição.
Parâmetro | Tipo | Descrição |
entidade | Integer (obrigatório) | Entidade a ser afetada, deve ser um valor contido na lista de entidades disponíveis para etiquetas. |
idEntidade | Integer (obrigatório) | ID da entidade a ser afetada. |
idsEtiquetas | Integer[] (obrigatório) | IDs das etiquetas a serem salvas na entidade |
JSON enviado (exemplo):
{
"entidade": 1,
"idEntidade": 441,
"idsEtiquetas": [13,25]
}
JSON retornado (exemplo):
[
"entidade": 1,
"idEntidade": 441,
"etiquetas":
[
{
"id": 13,
"nome": "Importante",
"color": "#000000",
"backgroundColor": "#ffff00"
},
{
"id": 25,
"nome": "Em andamento",
"color": "#000000",
"backgroundColor": "#95ff95"
}
]
]
Filtrar etiquetas
Path: /api/v2/etiquetas
Método: GET
Parâmetros a serem repassados na URL como Query Param:
Query Param | Tipo | Descrição |
page | Integer (opcional) | Número da página |
page | Integer (opcional) | Tamanho da página (quantidade de registros, padrão: 25) |
offset | Integer (opcional) | Quantidade de registros para pular ao exibir a página (com base no número e tamanho da página) |
sort | String (opcional) | Parâmetro e sentido de ordenação |
entidade | Integer (opcional) | Tipo da entidade |
idEntidade | Integer (opcional*) | ID da entidade, ou seja, do processo, caso, contrato, etc.
Regras: somente poderá ser enviado quando o parâmetro "entidade" for informado. |
nome | String (opcional) | Nome da etiqueta |
Exemplo:
Path: /api/v2/etiquetas?pageNumber=1&pageSize=5&offset=0&sort=asc&entidade=11&idEntidade=100&nome=cadastro
JSON retornado (exemplo):
{
"content": [
{
"id": 1,
"entidade": 7,
"idEntidade": 160,
"etiqueta": {
"id": 2,
"nome": "Cadastro",
"color": "#000000",
"backgroundColor": "#ff6562"
}
},
{
"id": 351,
"entidade": 9,
"idEntidade": 1005,
"etiqueta": {
"id": 2,
"nome": "Importante",
"color": "#000000",
"backgroundColor": "#ff6562"
}
},
{
"id": 480,
"entidade": 1,
"idEntidade": 2050028,
"etiqueta": {
"id": 2,
"nome": "Compromisso",
"color": "#000000",
"backgroundColor": "#ff6562"
}
},
{
"id": 483,
"entidade": 11,
"idEntidade": 3010471,
"etiqueta": {
"id": 2,
"nome": "Cadastro",
"color": "#000000",
"backgroundColor": "#ff6562"
}
},
{
"id": 499,
"entidade": 8,
"idEntidade": 5015,
"etiqueta": {
"id": 2,
"nome": "Validação",
"color": "#000000",
"backgroundColor": "#ff6562"
}
},
{
"id": 506,
"entidade": 8,
"idEntidade": 1020153,
"etiqueta": {
"id": 2,
"nome": "Cadastro",
"color": "#000000",
"backgroundColor": "#ff6562"
}
}
],
"pageable": {
"sort": {
"empty": true,
"sorted": false,
"unsorted": true
},
"offset": 0,
"pageNumber": 0,
"pageSize": 25,
"paged": true,
"unpaged": false
},
"totalElements": 484,
"totalPages": 20,
"last": false,
"size": 25,
"number": 0,
"sort": {
"empty": true,
"sorted": false,
"unsorted": true
},
"numberOfElements": 25,
"first": true,
"empty": false
}
Listar entidades disponíveis para etiquetas.
Path: /api/v2/etiquetas/entidades
Método: GET
JSON retornado (exemplo):
[
{
"entidade": 1,
"nome": "Processo"
},
{
"entidade": 2,
"nome": "Contrato"
},
{
"entidade": 7,
"nome": "Solicitação"
},
{
"entidade": 8,
"nome": "Publicação"
},
{
"entidade": 10,
"nome": "Desdobramento"
},
{
"entidade": 11,
"nome": "Andamento"
}
]
Listar etiquetas cadastradas de uma entidade
Path: /api/v2/etiquetas/entidades/:entidade/:idEntidade
Método: GET
O parâmetro entidade deve receber o código da entidade desejada, conforme a tabela abaixo. Já o parâmetro idEntidade deve receber o ID do registro correspondente.
Entidades disponíveis:
Código | Entidade |
1 | Processo |
2 | Contrato |
7 | Solicitação |
8 | Publicação |
10 | Desdobramento |
11 | Andamento |
Exemplo:
Path: /api/v2/etiquetas/entidades/11/20511
Neste exemplo, o valor 11 representa a entidade Andamento e o valor 20511 corresponde ao ID do andamento.
JSON Retornado (exemplo):
{
"entidade": 11,
"idEntidade": 20511,
"etiquetas": [
{
"id": 25,
"nome": "Importante",
"color": "#000000",
"backgroundColor": "#95ff95"
},
{
"id": 2,
"nome": "Cadastro",
"color": "#000000",
"backgroundColor": "#ff6562"
},
{
"id": 13,
"nome": "Amarelo",
"color": "#000000",
"backgroundColor": "#ffff00"
}
]
}
Listar etiquetas disponíveis para cadastro em uma entidade
Path: /api/v2/etiquetas/entidades/:entidade
Método: GET
Parâmetro "entidade" deve ser uma das entidades disponíveis para etiquetas (conforme rota disponibilizada abaixo).
Exemplo:
Path: /api/v2/etiquetas/entidades/11
JSON retornado (exemplo):
[
{
"id": 13,
"nome": "Importante",
"color": "#000000",
"backgroundColor": "#ffff00"
},
{
"id": 25,
"nome": "Em andamento",
"color": "#000000",
"backgroundColor": "#95ff95"
},
{
"id": 2,
"nome": "Cadastro",
"color": "#000000",
"backgroundColor": "#ff6562"
}
]
Ficou com alguma dúvida? Entre em contato com nosso time de suporte pelo e-mail suporte@aurum.com.br ou, se preferir, utilize o ícone de chat disponível diretamente no Themis. Estamos à disposição para ajudar.
Estes artigos podem interessar a você: