ナビゲーションにスキップ

ドキュメントを更新

ドキュメントの名前、内容、自動同期設定のいずれか、または複数を更新します。

パスパラメータ

documentation_idstring必須

ナレッジベース内のドキュメントのID。ドキュメント追加時に返されます。

ヘッダー

xi-api-keystringオプション

リクエスト

This endpoint expects an object.
namestring or nullオプション>=1 character

ドキュメント用のカスタムの人間が読みやすい名前です。

contentstring or nullオプション

ドキュメントの更新後のコンテンツ。テキストドキュメント、自動同期が無効なURLドキュメント、外部ソースと同期していないファイルドキュメントでのみサポートされます。

enable_auto_syncboolean or nullオプション

ドキュメントまたはフォルダーを自動的に更新するかどうかです。URLドキュメント、フォルダー、外部同期ファイルにのみ適用されます。現在の値を維持するには未設定のままにします。

auto_removeboolean or nullオプション

ソースが利用できなくなったときにドキュメントを自動的に削除するかどうかです。自動同期が有効な場合にのみ適用されます。現在の値を維持するには未設定のままにします。

minimum_frequency_daysinteger or nullオプション1-180

ドキュメントを更新する最小頻度(日数)です。実際の間隔は短くなる場合がありますが、長くなることはありません。自動同期が有効な場合にのみ適用されます。現在の値を維持するには未設定のままにします。

tighten_onlybooleanオプションデフォルト値 false

フォルダーにのみ適用されます。trueの場合、フォルダー内の既存項目には、少なくともフォルダーと同じ厳しさになるよう設定が適用され、フォルダーより厳しい設定は維持されます。falseの場合、フォルダーの自動同期設定と完全に同じ設定になります。外部同期フォルダーでは無視され、内容は常にフォルダーのスケジュールに従います。

レスポンス

成功レスポンス。

urlobject
OR
fileobject
OR
textobject
OR
folderobject

エラー

422
Unprocessable Entity Error