Skip to main content
PATCH
/
note_sections
Atualizar seção da nota
curl --request PATCH \
  --url https://api-sandbox.connectvets.com.br/notes/v1/note_sections \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "title": "Exame Físico",
  "content": "Animal apresenta bom estado geral...",
  "order": "2",
  "label": "exame_fisico"
}
'
{
  "id": "abc123-def456-ghi789",
  "title": "Anamnese",
  "label": "anamnese",
  "content": "Paciente apresenta sintomas de...",
  "order": "1"
}

​
Casos de Uso

Este endpoint permite atualizar seções específicas de uma nota após sua criação:
  • Correção de dados: Corrigir informações em seções específicas
  • Enriquecimento: Adicionar informações complementares a uma seção
  • Reorganização: Alterar ordem de exibição das seções
  • Categorização: Atualizar labels para melhor organização
Permissões: Este endpoint requer uma API Key com permissões de escrita (write) ou administrador (admin).
Rate Limiting: Este endpoint está sujeito aos limites da sua API Key (padrão: 100 req/min, 1000 req/hora).

​
Parâmetros

​
Query Parameters

ParâmetroTipoObrigatórioDescrição
section_idstring (UUID)✅ID da seção que será atualizada

​
Request Body

CampoTipoObrigatórioDescrição
titlestring✅Título da seção
contentstring✅Conteúdo da seção
orderstring✅Ordem de exibição (ex: “1”, “2”, “3”)
labelstring❌Rótulo interno para classificação

​
Exemplos de Uso

​
Atualizar Conteúdo de uma Seção

const response = await fetch('/note_sections?section_id=123e4567-e89b-12d3-a456-426614174000', {
  method: 'PATCH',
  headers: {
    'X-API-KEY': 'sua_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Exame Físico',
    content: 'Exame físico atualizado: Animal apresenta melhora significativa...',
    order: '2',
    label: 'exame_fisico'
  })
});

const updatedSection = await response.json();

​
Reorganizar Ordem das Seções

// Exemplo: Mover seção para primeira posição
const response = await fetch('/note_sections?section_id=123e4567-e89b-12d3-a456-426614174000', {
  method: 'PATCH',
  headers: {
    'X-API-KEY': 'sua_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Anamnese',
    content: 'História clínica detalhada...',
    order: '1'  // Movendo para primeira posição
  })
});

​
Resposta

​
Sucesso (200)

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "note_id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Exame Físico",
  "label": "exame_fisico",
  "content": "Exame físico atualizado: Animal apresenta melhora significativa...",
  "order": "2",
  "created_at": "2024-02-14T10:30:00Z",
  "updated_at": "2024-02-14T15:45:00Z"
}

​
Códigos de Erro

CódigoDescriçãoSolução
400Parâmetros inválidos ou malformadosVerifique se o section_id é um UUID válido
401API Key inválida ou não fornecidaVerifique o header X-API-KEY
403Permissões insuficientesUse uma API Key com permissões de escrita
404Seção não encontradaVerifique se o section_id existe
422Dados de entrada inválidosVerifique se todos os campos obrigatórios estão presentes

​
Notas Importantes

Versionamento: As atualizações criam uma nova versão da seção, mantendo o histórico através do campo updated_at.
Validação: O campo order deve ser uma string numérica válida. Recomenda-se usar valores sequenciais como “1”, “2”, “3” para facilitar a ordenação.
Workflow Recomendado:
  1. Use GET /notes/{id} para obter as seções existentes
  2. Identifique o section_id da seção que deseja atualizar
  3. Faça a atualização com PATCH /note_sections
  4. Verifique o resultado com outro GET /notes/{id}

Authorizations

​
X-API-KEY
string
header
required

API Key para autenticação

Query Parameters

​
section_id
string<uuid>
required

ID da seção a ser atualizada

Body

application/json
​
title
string
required

Título da seção

Example:

"Exame Físico"

​
content
string
required

Conteúdo da seção

Example:

"Animal apresenta bom estado geral..."

​
order
string
required

Ordem de exibição (ex. "1", "2", "3")

Example:

"2"

​
label
string

Rótulo interno para classificação

Example:

"exame_fisico"

Response

Seção atualizada com sucesso

​
id
string<uuid>

ID da seção

Example:

"abc123-def456-ghi789"

​
title
string

Título da seção

Example:

"Anamnese"

​
label
string

Label da seção

Example:

"anamnese"

​
content
string

Conteúdo da seção

Example:

"Paciente apresenta sintomas de..."

​
order
string

Ordem da seção

Example:

"1"