ホーム 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/copy

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

    リクエストヘッダ

    キー 必須 説明
    Content-Type 送信データのMIMEタイプは、下記を指定。
    application/json
    Authorization OAuth認証スキーム。
    「Bearer + スペース + <access_token>」の形式でアクセストークンを指定する。
    詳細は API共通リファレンス 2.3を参照。

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

    リクエストボディ(JSON形式)

    キー 必須 説明
    owner_ap_cd オーナーAPコードを指定。
    IFを発行したAPを特定する。
    設定値の説明については 仕様書「コード定義」参照。
    -
    after_info 複製先情報。
       id フォルダ管理のID(格納先フォルダID)を指定。
    name 複製先のフォルダの名称(フルパス)を指定。
    詳細は 仕様書「使用可能文字、使用禁止文字について」を参照。
    TOPフォルダを指定する場合は空文字("name":"") を指定する。
    before_info 複製元情報。
       id ファイル / フォルダ管理のID(複製するファイル / フォルダID)を指定。
    name 複製元のファイル / フォルダの名称(フルパス)を指定。
    詳細は 仕様書「使用可能文字、使用禁止文字について」を参照。
    revision ファイル / フォルダの更新情報を管理する連番を指定(1~2147483647)。

    レスポンスヘッダ

    キー 必須 説明
    Content-Type 受信データのMIMEタイプは、下記を返却。
    application/json

    レスポンスボディ(処理成功)(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)。
    ファイル : 新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時
    フォルダ : フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時

    レスポンスボディ(処理失敗)(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モードコンテンツ」に関するお問い合わせです。よくあるご質問や技術ブログで解決しない場合は、お問い合わせください。