POST Criar Atalho da Máscara
Cria um atalho para a máscara de relatório.
Autenticação necessária
Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.
Sem permissão específica
Não exige @CheckPermissions — basta estar autenticado.
Endpoint
POST https://api-dev.imagemais.com.br/api/report-masks/{id}/shortcuts
Parâmetros de Rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | ✅ | ID da máscara |
Corpo da Requisição
| Campo | Tipo | Obrigatório | Valores válidos | Descrição |
|---|---|---|---|---|
keyword | string | ✅ | não vazio | Palavra-chave que dispara o atalho |
field | string | ✅ | não vazio | Campo da máscara em que o atalho atua |
text | string | ✅ | não vazio | Texto inserido pelo atalho |
color | string | ❌ | — | Cor do atalho |
Requisição
curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/report-masks/abc123/shortcuts' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"keyword": "exemplo",
"field": "texto",
"text": "Texto de exemplo",
"color": "#1976d2"
}'
Respostas
201 Sucesso
{
"status": true,
"data": {
"id": 1,
"keyword": "normal",
"field": "content",
"text": "Exame dentro da normalidade.",
"color": "#2e7d32",
"reportMaskId": 2
}
}
400 Requisição inválida
Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:
{
"message": [
"keyword should not be empty",
"keyword must be a string",
"field should not be empty",
"field must be a string",
"text should not be empty",
"text must be a string"
],
"error": "Bad Request",
"statusCode": 400
}