メインコンテンツまでスキップ

スキーマ検出 (Schema Discovery)

実行時に Docwize インスタンスの構造を検出します。これらのエンドポイントを使用すると、フィルタ可能なすべてのフィールド(コアドキュメントの列とカスタムフィールドテンプレートの列の両方)を列挙し、それらの個別の値を取得できます。

これらのエンドポイントを使用して、動的なフィルタ UI を構築したり、検索クエリを作成する前に値を検証したり、オートコンプリートのドロップダウンにデータを入力したりできます。


エンドポイント​

メソッドパス説明スコープ
GET/apiv2/pub/schema/fieldsフィルタ可能なすべてのフィールド(ドキュメント + カスタムフィールド)を一覧表示しますdocuments_read
GET/apiv2/pub/schema/values/{field_name}任意のフィールドの個別の値を取得しますdocuments_read