Skip to main content
Obtenha o conteúdo completo e as relações de navegação de um único documento por meio do UUID ou alias do documento. Quando o alias for conhecido, é possível fazer a solicitação diretamente, sem precisar filtrar primeiro na lista.

​
Visão Geral da API

​
Parâmetros

  • id_or_alias: UUID do documento, alias atual ou alias antigo preservado em redirect_from.
  • lang: dica de idioma opcional; também é possível usar Accept-Language. O idioma final do conteúdo está sujeito a content_locale na resposta.

​
Descrição da Resposta

Os detalhes usam uma resposta de objeto único, contendo atualmente:
  • id, alias, redirect_from, name, title, type, rank, tags;
  • content, content_mode, content_locale, content_hash;
  • parent, sibling e resumos públicos de children ordenados por rank;
  • associações api / proxy / dataset / integration, e agent (quando existir).
A resposta não possui o campo breadcrumbs. Ao construir breadcrumbs, é possível continuar lendo os detalhes de parent ou usar as relações do diretório de documentos já armazenadas em cache.

​
Tratamento de Erros

  • ID/alias não existe ou não corresponde à visibilidade atual do site: 404. private controla apenas a visibilidade na lista, não impede a leitura direta por quem conhece o link e não pode ser usado como limite de confidencialidade.
  • A rota atual usa o formato sem barra final; não dependa da camada de proxy para adicionar automaticamente a barra final.

​
APIs Relacionadas