名前

型

説明

path

String, 必須

フォルダのパスを指定します。このフォルダ直下および全子孫フォルダの中から検索します。パスについてはこちらをご覧ください。

query

String, 必須

検索文字列。

Ver3.12.0.16 ～ 利用可能
ファイル名、種類、日付、サイズ検索に対応しました。

例えば以下のようにquery値を指定することで、ファイル名、種類、日付、サイズ検索が可能です。

例）あいうえお title:xyz type:word date:today size:10MB-

検索式の仕様は、検索ツールバーのテキストボックスに入力できる書式と同じです。

詳しくはこちらを参照してください。

limit

Integer

最大取得件数を指定します。デフォルトは100です。

offset

Integer

取得開始オフセット、先頭から取得する場合0を指定します。デフォルトは0です。

attributes

String

追加して取得したい属性があれば指定します。カンマ区切りで属性名を列挙してください。指定できる属性名については/files/list_folderを参照してください。

orderby

String

ソート（昇順）に使用するフィールド名を指定します。 以下の値を使用できます。デフォルトはnameです。

name

size

creationtime

lastwritetime

extension

なお、list_folderと違いsearchではorderbyパラメータにtext,strcmplogicalを指定できない仕様になっています。

orderbydescending

String

ソート（降順）に使用するフィールド名を指定します。orderbyが指定されていた場合は無視されます。デフォルトはnameです。

utcoffset

Integer

協定世界時(UTC)との差を単位:分で指定します。サーバーとクライアントのタイムゾーンが一致する場合には指定しなくても正しい検索結果を得られますが、異なる場合には、例えば日本であれば-540のように指定してくd歳。ただし、queryに日付条件を含める場合にのみ必要です。

名前

値

説明

entries

配列

entry(ファイル、フォルダ情報)の配列です。

name

String

ファイル、フォルダ名です。

path

String

親フォルダのパスです。

creationtime

Timestamp

作成日時(ISO8601 形式)です。

lastwritetime

Timestamp

更新日時(ISO8601 形式)です。

is_dir

Boolean

ディレクトリの場合はtrueが返されます。

size

Integer

ファイルサイズです。フォルダの場合は-1になります。

attributes

リクエスト時にattributesを指定した時にだけ（指定した属性のみ）返されます。

total_count

Integer

ヒットした件数です。entryの数ではなく条件にマッチした総数,この値を上限にlimit,offset値を指定してpagingが可能です。