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.

    Moving Files/Folders(Name Change)

    Moves the folders/files specified with IDs to specified folders, or changes names with specified names.
    (Note) Even when the names are changed, folder IDs/file IDs are not changed. In case of move inside its own domain, only the parement folder ID is changed and folder IDs or file IDs are not changed.

    Request URL

    https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/move

    Method : POST
    Character code : UTF-8

    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.
    after_info Information after move (Name change).
       id - ID to manage folders(Storing folder ID).
    *Required only in case of moving.
    *No specified in case of name change.
    At name change: Not specified.
    When moving: Specified.
    name File/folder name (full path) after moving (name change).
    *In case of moving, the full path up to move-to parent folder is set.
    See "使用可能文字、使用禁止文字について"('Allowed characters, prohibited characters') in the specification for details.
    Null characters ("name":"") are set in case of TOP folder.
    before_info Information before move (Name change).
       before_info_list List of before move information.
    Multiple setting is possible only in case of moving.
       - Information before move.
       id ID to manage files/folders(Folder/file ID to be moved).
    name File/folder name (full path) before moving (name change).
    *In case of folder name change, name of the lowest layer of path.
    See "使用可能文字、使用禁止文字について"('Allowed characters, prohibited characters') in the specification for details.
    revision Serial number managing update information of folders/files(1~2147483647).

    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(1~2147483647).
    meta_info_list List of 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.