Ir para a navegação

Atualizar documento

Atualize o nome, o conteúdo e/ou as configurações de sincronização automática de um documento.

Parâmetros de caminho

documentation_idstringObrigatório

O ID de um documento da base de conhecimento. Ele é retornado ao adicionar o documento.

Cabeçalhos

xi-api-keystringOpcional

Solicitação

This endpoint expects an object.
namestringOpcional>=1 character

Um nome personalizado e legível para humanos para o documento.

contentstringOpcional

Conteúdo atualizado do documento. Compatível apenas com documentos de texto, documentos de URL com sincronização automática desativada e documentos de arquivo que não são sincronizados de uma fonte externa.

enable_auto_syncbooleanOpcional

Se o documento ou a pasta é atualizado automaticamente. Aplicável apenas a documentos por URL, pastas e arquivos sincronizados externamente. Deixe sem definir para manter o valor atual.

auto_removebooleanOpcional

Se o documento deve ser removido automaticamente quando sua fonte não estiver mais disponível. Aplicável apenas quando a sincronização automática está ativada. Deixe sem definir para manter o valor atual.

minimum_frequency_daysintegerOpcional1-180

Frequência mínima (em dias) com que o documento é atualizado. O intervalo real pode ser menor, mas nunca maior. Aplicável apenas quando a sincronização automática está ativada. Deixe sem definir para manter o valor atual.

tighten_onlybooleanOpcionalPadrão é false

Somente pastas. Quando true, os itens que já estão na pasta são apenas ajustados para permanecer pelo menos tão restritivos quanto a pasta e mantêm qualquer configuração mais restritiva que a da pasta. Quando false, são definidos exatamente com as configurações de sincronização automática da pasta. Ignorado para pastas sincronizadas externamente, cujo conteúdo sempre segue a programação da pasta.

Resposta

Resposta bem-sucedida

urlobject
OR
fileobject
OR
textobject
OR
folderobject

Erros

422
Documents Update Request Unprocessable Entity Error