ホーム API/ツール API データ保管BOX

データ保管BOX

    データ保管BOX APIでは、クラウドストレージエリアとの通信を隠蔽し、データ保管BOX 上のフォルダ / ファイルリストの取得、ファイルのアップロード、ダウンロードといった機能を提供します。

    API
    基本情報
    提供 : REST,SDK(Android™,iOS)
    • 審査 : アプリ審査
    ご利用いただくためには「アカウント登録(無料)」が必要です。

    リファレンスを参照するAPI機能名を選択してください

    ファイル / フォルダ差分情報取得

    IDおよびパスによって指定されたファイル / フォルダ差分情報を取得します。

    リクエストURL

    https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/difference/{path}

    メソッド : GET
    文字コード : UTF-8

    リクエストパスパラメータ

    キー 必須 説明
    {path} メタ情報の取得対象パスを指定。
    長さは159文字を上限とする。
    全角、半角に関わらず文字数としてカウントする。
    ("/"区切りでデータ保管BOXのルートからの絶対パス ファイル指定も可能とする)

    リクエストヘッダ

    キー 必須 説明
    Authorization OAuth認証スキーム。
    「Bearer + スペース + <access_token>」の形式でアクセストークンを指定する。
    詳細は API共通リファレンス 2.3を参照。

    ※OAuth を利用するためのAndroid™、iOSおよびJava SDKを提供しております。 こちらを参照ください。

    リクエストクエリパラメータ

    キー 必須 説明
    owner_ap_cd オーナーAPコードを指定。
    IFを発行したAPを特定する。
    設定値の説明については 仕様書「コード定義」参照。
    id - ファイル / フォルダ管理のIDを指定。
    任意項目であるが、内部キャッシュなどでIDを保持している場合は、必ず指定する。
    指定なしとした場合は、移動・名称変更に関するエラーコードを返却できない。
    revision 差分取得対象のリビジョン番号を指定(1~2147483647)。
    rev_flg - サブフォルダを参照するかを示すフラグを指定。
    ※第二階層以降も再帰フラグを持つ。
    設定値の説明については 仕様書「コード定義」参照。
    attribute_cd - 取得対象となるファイル属性を示すコードを指定。
    設定値の説明については 仕様書「コード定義」参照。
    省略時 : 削除を含めたすべての情報を取得。
    validation_date - 有効期間超過チェックの対象日付を指定(yyyy/mm/dd hh:mm:ss形式)。
    指定なしの場合、検証日付チェックを行わない。
    display_num 表示件数の最大値を指定(1~9999)。
    取得結果がこの数値を超えていた場合はエラーとする。
    省略時 : 対象をすべて返却。
    指定時 : 指定件数で返却。

    レスポンスボディ(処理成功)(JSON形式)

    キー 必須 説明
    display_num 取得件数を返却。
    meta_info_list メタ情報のリスト。
       - メタ情報。
       parent_folder_id 親となるフォルダIDを返却。
    ルートフォルダの場合、もしくは被コラボ大元フォルダの場合はnull。
    id ファイル / フォルダ管理のIDを返却。
    name ファイルまたはフォルダ名のフルパスを返却。
    type_cd 種別コードを返却。
    ファイルとフォルダを区別する。
    設定値の説明については 仕様書「コード定義」参照。
    hash_value - ファイルのハッシュ値を返却(ハッシュ関数はMD5)。
    フォルダの場合は存在しない。
    size - ファイルのサイズを返却。
    フォルダの場合は存在しない。
    status_cd 状態コードを返却。
    ファイル / フォルダの状態(お預かり済み)を示す。
    設定値の説明については 仕様書「コード定義」参照。
    delete_status_cd 削除状態コードを返却。
    ファイル / フォルダの削除情報を示す。
    設定値の説明については 仕様書「コード定義」参照。
    delete_reason_cd 削除要因コードを返却。
    ファイル / フォルダを削除した要因を示す。
    設定値の説明については 仕様書「コード定義」参照。
    revision 更新情報を管理する連番を返却(1~2147483647)。
    share_status_cd 共有状態種別コードを返却。
    設定値の説明については 仕様書「コード定義」参照。
    update_date 更新日付を返却(yyyy/mm/dd hh:mm:ss形式)。
    ファイル : 新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時
    フォルダ : フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時
    move_date 最終移動更新日時を返却(yyyy/mm/dd hh:mm:ss形式)。
    指定したフォルダ配下のファイル / フォルダが移動をした最終日付。
    移動未実施の場合は、nullを設定する。

    レスポンスボディ(処理失敗)(JSON形式)

    キー 必須 説明
    meta_info メタ情報。
       parent_folder_id 親となるフォルダIDを返却。
    ルートフォルダの場合、もしくは被コラボ大元フォルダの場合はnull。
    id ファイル / フォルダ管理のIDを返却。
    name ファイルまたはフォルダ名のフルパスを返却。
    type_cd 種別コードを返却。
    ファイルとフォルダを区別する。
    設定値の説明については 仕様書「コード定義」参照。
    hash_value - ファイルのハッシュ値を返却(ハッシュ関数はMD5)。
    フォルダの場合は存在しない。
    size - ファイルのサイズを返却。
    フォルダの場合は存在しない。
    status_cd 状態コードを返却。
    ファイル / フォルダの状態(お預かり済み)を示す。
    設定値の説明については 仕様書「コード定義」参照。
    delete_status_cd 削除状態コードを返却。
    ファイル / フォルダの削除情報を示す。
    設定値の説明については 仕様書「コード定義」参照。
    delete_reason_cd 削除要因コードを返却。
    ファイル / フォルダを削除した要因を示す。
    設定値の説明については 仕様書「コード定義」参照。
    revision 更新情報を管理する連番を返却(1~2147483647)。
    share_status_cd 共有状態種別コードを返却。
    設定値の説明については 仕様書「コード定義」参照。
    update_date 更新日付を返却(yyyy/mm/dd hh:mm:ss形式)。
    ファイル : 新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時
    フォルダ : フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時
    よくあるご質問
    APIなどの各サービスに関するよくある質問を掲載します。
    お問い合わせ
    「docomo Developer support」及び「作ろうスマートフォン/iモードコンテンツ」に関するお問い合わせです。よくあるご質問や技術ブログで解決しない場合は、お問い合わせください。