ジャンプ先

• リクエスト
• レスポンス

すべてのアセットの検索

get

/resources/v1/search/assets

リソース・エンドポイントは、サイトのすべてのアセットのリストを返します。
これは、コレクション・リソースです。

注意: このリソースにアクセスするには、検索基準を1つ以上指定する必要があります。

リクエスト

問合せパラメータ

• countonly: boolean
  ブール値を受け入れます。trueに設定すると、件数のみ表示され、結果は返されません。デフォルトはfalseです。
• field:[fieldname]:[operation]: string
  指定した演算を使用した[fieldname]のフィールドに対する問合せ条件を指定します。[Operation]はオプションで、equals、range、startswith、phrase、wildcard、similarまたはcontainsのいずれかを指定できます。デフォルトはcontainsです。range演算については、値の書式は{lower bound}:{upper bound}(たとえば、1:10)です。
• fields: string
  各検索結果の属性名のカンマ区切りのリストを受け入れます。デフォルトでは、各検索結果の名前と説明のみ返されます。
• limit: number
  返されるアイテムの合計数を指定します。
• links: string
  リンク名のカンマ区切りのリストを受け入れます。デフォルトでは、このパラメータですべてのリンク(next、prev、first、last、schema、selfおよびcanonicalリソース)が返されます。
• offset: number
  結果を返す開始地点となる開始索引を指定します。
• orderBy: string
  結果のソート基準になるフィールドを指定します。
  使用方法: orderBy=[fieldname]:[asc/des]。
  注意: Luceneでは、トークン化されていない索引付けフィールドのみソートできます。
• q: string
  問合せ文字列を指定します。これは、構成時に指定された検索エンジン固有の問合せです。(デフォルトの検索エンジンはLuceneです。)
• searchengine: string
  検索に使用する検索エンジンを指定します。デフォルトの検索エンジンはLuceneです。
• totalResults: boolean
  ブール値を受け入れます。trueに設定すると、レスポンスに結果総数フィールドが表示されます。デフォルトはfalseです。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json
• application/xml

200レスポンス

すべてのアセットのリスト

先頭に戻る