フォルダを作成

ドキュメントをグループ化するためのフォルダを作成します。

ヘッダー

xi-api-keystringオプション

リクエスト

This endpoint expects an object.
namestring必須>=1 character

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

parent_folder_idstring or nullオプション

設定すると、作成されたドキュメントまたはフォルダは指定したフォルダ内に配置されます。

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

このURLドキュメントで自動同期を有効にするかどうか。

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

URLが利用できなくなった場合にドキュメントを自動削除するかどうか。自動同期が有効な場合にのみ適用されます。

minimum_frequency_daysinteger or nullオプション1-180

対象となる基盤ドキュメントを更新する最小頻度(日数)。実際の間隔はこれより短くなる場合がありますが、長くなることはありません。デフォルトは7で、親フォルダの頻度がより厳しい場合はそれに合わせて短縮されます。自動同期が有効な場合にのみ適用されます。

レスポンス

成功レスポンス。

idstring
namestring
folder_pathlist of objectsオプション

ルートから親フォルダまでの、このエンティティにつながるフォルダパスセグメント。

エラー

422
Unprocessable Entity Error