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.

    Acquisition of File/Folder Information(Acquisition of Meta Information)

    Obtains file/folder information specifided with IDs and paths.

    Request URL

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

    Method : GET
    Character code : UTF-8

    Request Path Parameter

    key Mandatory Description
    {path} Assign target path of meta-information.
    Length limit is 159 words.
    Regardless of whether one-byte or two-byte, counted as one word.
    (You can assign absolute path from Data Storage BOX root path by separating with "/".)

    Request Header

    key Mandatory Description
    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 Query Parameters

    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.
    rev_flg - Flag to indicate whether subfolders are referenced.
    *The second layers and beyond also have recursive flags.
    See "コード定義"('Code definition') in the specification for description of setting values.
    id - ID to manage files/folders
    Although this item is optional, in case IDs are held in the internal cache etc., specification must be made.
    In case of no specification, error codes concerning move and name change cannot be returned.
    attribute_cd - Code to indicate file attributes corresponding to acquisition.
    See "コード定義"('Code definition') in the specification for description of setting values.
    In case omitted: Obtains all the information including deletion.

    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 corresponding to the specified conditions.
    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 names.
    Null characters ("name":"") are set in case of TOP folder.
    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).
    Does not exist in case of folders.
    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(1~2147483647).
    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.
    object_name Object name used when accessing S3.
    Returns only in case of files.
    validation_date Validation date(yyyy/mm/dd hh:mm:ss Format).
    move_date Final move update date and time(yyyy/mm/dd hh:mm:ss Format)
    Final date when the folders/files under the specified folder moved.
    Null is set in case movement has not taken place.

    Response Body (Processing Failure)(JSON Format)

    key Mandatory Description
    meta_info 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 names.
    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).
    Does not exist in case of folders.
    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.
    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.