Home APIs/Tools API Data Storage BOX

Data Storage BOX

    With Data Storage API you can obtain the folders/files stored in the your Data Storage Box. You can also download/upload files etc.

    API
    Basic Information
    Resources : REST,SDK(Android™,iOS)
    • Requirement : App Review
    ご利用いただくためには「アカウント登録(無料)」が必要です。

    Please check to the API reference document and select the API endpoint.

    Deletion of Files/Folders

    Logically deletes files/folders specified with IDs , paths, and with/without revision.
    In case folders are to be deleted, only the meta information of corresponding folders are returned.
    In case files/folders to be deleted do not exist, it is considered an error.

    Request URL

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

    Method : POST
    Character code : UTF-8

    Request Path Parameter

    key Mandatory Description
    {path} Assign path of which it is deleted to parent folder.
    Length limit is 159 words.
    Regardless of whether one-byte or two-byte, counted as one word.
    You have to describe absolute path from Data Storage BOX root by separating with "/".

    Request Header

    key Mandatory Description
    Content-Type Specifies the "application/json".
    Authorization OAuth authentication scheme.
    See API Common Reference 2.3 for details.

    * With our SDK for Android™, iOS and Java, you can develop your Apps using our OAuth. Here is the SDK.

    Request Body (JSON Format)

    key Mandatory Description
    owner_ap_cd Code to identify the AP that issued the IF.
    See "コード定義"('Code definition') in the specification for description of setting values.
    delete_info_list List of information to be deleted.
       Information to be deleted Information to be deleted.
       id ID to manage files/folders.
    name Names of files/folders to be deleted(Full path).
    See "使用可能文字、使用禁止文字について"('Allowed characters, prohibited characters') in the specification for details.
    revision - Revision number(1~2147483647).
    Not specified: Delete without checking the revision.
    Specified: Delete by checking the revision.

    Response Header

    key Mandatory Description
    Content-Type application/json is returned.

    Response Body (Processing Success)(JSON Format)

    key Mandatory Description
    meta_info_total Total number of meta information specified with the request.
    meta_info_list List of meta information.
       Meta information Meta information.
       parent_folder_id Parent folder ID.
    Null in case of root folder or collaborated root folder.
    id ID to manage files/folders.
    name Full path of file or folder name.
    type_cd Distinguishes files and folders.
    See "コード定義"('Code definition') in the specification for description of setting values.
    hash_value - Hash values of files (Hash function is MD5).
    size - File size.
    Does not exist in case of folders.
    status_cd Indicates status(Stored) of files/folders.
    See "コード定義"('Code definition') in the specification for description of setting values.
    delete_status_cd Indicates deletion information of files/folders.
    See "コード定義"('Code definition') in the specification for description of setting values.
    delete_reason_cd Indicates reasons for deleting files/folders.
    See "コード定義"('Code definition') in the specification for description of setting values.
    revision Serial number managing update information.
    share_status_cd Shared status type code.
    See "コード定義"('Code definition') in the specification for description of setting values.
    update_date Update date(yyyy/mm/dd hh:mm:ss Format).
    File: Date and time when new and update upload was completed. In case of copy-to files, date and time the copy was completed.
    Folder: Date and time when file folder creation was completed. In case of copy-to folders, date and time the copy was completed.

    Response Body (Processing Failure)(JSON Format)

    key Mandatory Description
    id ID to manage files/folders.
    Among file/folder IDs in the request, those with errors are returned.
    FAQ
    You can find a list of FAQs on each API.
    Contact Us
    We can support you by answering your queries with regard to "docomo Developer Support" and "Tsukuro Smartphone/i-mode contents". Please check our FAQs and contact us here in case you cannot find a solution.