Atualizar Seção da Nota

Atualiza uma seção específica de uma nota.

Rate Limiting: Este endpoint está sujeito aos limites da sua API Key (padrão: 100 req/min, 1000 req/hora).

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âmetro	Tipo	Obrigatório	Descrição
`section_id`	string (UUID)	✅	ID da seção que será atualizada

Request Body

Campo	Tipo	Obrigatório	Descrição
`title`	string	✅	Título da seção
`content`	string	✅	Conteúdo da seção
`order`	string	✅	Ordem de exibição (ex: “1”, “2”, “3”)
`label`	string	❌	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ódigo	Descrição	Solução
`400`	Parâmetros inválidos ou malformados	Verifique se o `section_id` é um UUID válido
`401`	API Key inválida ou não fornecida	Verifique o header `X-API-KEY`
`403`	Permissões insuficientes	Use uma API Key com permissões de escrita
`404`	Seção não encontrada	Verifique se o `section_id` existe
`422`	Dados de entrada inválidos	Verifique 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:

Use GET /notes/{id} para obter as seções existentes
Identifique o section_id da seção que deseja atualizar
Faça a atualização com PATCH /note_sections
Verifique o resultado com outro GET /notes/{id}

OpenAPI

PATCH /note_sections

openapi: 3.0.3
info:
  title: ConnectVets Notes API
  description: API para transcrição e análise de consultas veterinárias
  version: 1.0.0
  contact:
    name: ConnectVets Support
    email: [email protected]
    url: https://connectvets.com.br
  license:
    name: Proprietary
    url: https://connectvets.com.br/terms
servers:
  - url: https://api-sandbox.connectvets.com.br/notes/v1
    description: Homologação
security:
  - ApiKeyAuth: []
paths:
  /note_sections:
    patch:
      tags:
        - Notes
      summary: Atualizar seção da nota
      description: >
        Atualiza uma seção específica de uma nota.


        **Rate Limiting**: Este endpoint está sujeito aos limites da sua API Key
        (padrão: 100 req/min, 1000 req/hora).
      operationId: updateNoteSection
      parameters:
        - name: section_id
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: ID da seção a ser atualizada
          example: 123e4567-e89b-12d3-a456-426614174000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - title
                - content
                - order
              properties:
                title:
                  type: string
                  description: Título da seção
                  example: Exame Físico
                label:
                  type: string
                  description: Rótulo interno para classificação
                  example: exame_fisico
                content:
                  type: string
                  description: Conteúdo da seção
                  example: Animal apresenta bom estado geral...
                order:
                  type: string
                  description: Ordem de exibição (ex. "1", "2", "3")
                  example: '2'
      responses:
        '200':
          description: Seção atualizada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoteSection'
        '400':
          description: Parâmetros inválidos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: bad_request
                message: Invalid section_id format
                code: INVALID_SECTION_ID
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Permissões insuficientes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: forbidden
                message: Insufficient permissions to update note sections
                code: INSUFFICIENT_PERMISSIONS
        '404':
          description: Seção não encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: not_found
                message: Note section not found
                code: SECTION_NOT_FOUND
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  schemas:
    NoteSection:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: ID da seção
          example: abc123-def456-ghi789
        title:
          type: string
          description: Título da seção
          example: Anamnese
        label:
          type: string
          description: Label da seção
          example: anamnese
        content:
          type: string
          description: Conteúdo da seção
          example: Paciente apresenta sintomas de...
        order:
          type: string
          description: Ordem da seção
          example: '1'
    Error:
      type: object
      properties:
        error:
          type: string
          description: Código do erro
          example: bad_request
        message:
          type: string
          description: Mensagem de erro
          example: Invalid audio format
        code:
          type: string
          description: Código específico
          example: INVALID_AUDIO_FORMAT
        details:
          type: object
          description: Detalhes adicionais do erro
  responses:
    Unauthorized:
      description: Não autorizado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: API Key missing or invalid
            code: INVALID_API_KEY
    UnprocessableEntity:
      description: Entidade não processável
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unprocessable_entity
            message: Audio file is too large
            code: AUDIO_TOO_LARGE
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API Key para autenticação

Começar

Conceitos

Integração

Exemplos

API Reference

Update section

Atualizar Seção da Nota

Casos de Uso

Parâmetros

Query Parameters

Request Body

Exemplos de Uso

Atualizar Conteúdo de uma Seção

Reorganizar Ordem das Seções

Resposta

Sucesso (200)

Códigos de Erro

Notas Importantes

OpenAPI

​Atualizar Seção da Nota

​Casos de Uso

​Parâmetros

​Query Parameters

​Request Body

​Exemplos de Uso

​Atualizar Conteúdo de uma Seção

​Reorganizar Ordem das Seções

​Resposta

​Sucesso (200)

​Códigos de Erro

​Notas Importantes

​OpenAPI

Atualizar Seção da Nota

Casos de Uso

Parâmetros

Query Parameters

Request Body

Exemplos de Uso

Atualizar Conteúdo de uma Seção

Reorganizar Ordem das Seções

Resposta

Sucesso (200)

Códigos de Erro

Notas Importantes

OpenAPI