データ保管box api技術資料 - amazon web services...data_storage_box_api_spec_v1.10.xlsx...

©2014 NTT DOCOMO, INC. All Rights Reserved.

【データ保管BOXAPI】

データ保管BOX API技術資料

第1.10版

2014年11月4日

株式会社NTTドコモ

Data_Storage_BOX_API_spec_v1.10.xlsx

変更履歴

項番版数変更日変更者変更箇所変更内容変更理由

1 1.00 2014/3/17 初版

2 1.10 2014/11/4 エラーコード一覧・409の説明について、「操作対象にスキャンNGファイルが含まれている場合」を追記・409のリトライ可否について、「スキャンNGファイルを削除して再実施」を追記

変更履歴 - 2


メッセージフォーマット凡例

セクション項目名説明

リクエスト情報種別パラメータの配置場所や形式による種別を表す。

レスポンス情報 URI Path リクエストURIのパス名に埋め込まれたパラメータ

URI Query リクエストURIのクエリパラメータ

HTTP Header HTTPヘッダ（Cookie以外; 特記すべきもののみ記載）Cookie HTTPヘッダにセットされるCookie（特記すべきもののみ記載）

Form application/x-www-form-urlencoded またはmultipart/form-data 形式のボディにセットされるフォームパラメータ

JSON Element JSONオブジェクトのメンバ (Member)、または配列の要素 (Element) となる項目

XML Element XML要素 (Element)

XML Attribute XML要素の属性 (Attribute)

階層 JSONまたはXML要素の階層番号。

論理項目名 -

物理項目名 -

データ型以下のいずれか

string 文字列

number 数値（任意精度の符号付小数）

int 32ビット符号付整数 (-231 ～ +(231-1))long 64ビット符号付整数 (-263 ～ +(263-1))array 配列

object オブジェクト

null

項目出現数（最小/最大）null不可

省略時値

数値（最小/最大）文字列長（最小/最大）設定値項目書式や取りうる値の詳細など。

説明項目の意味、用途などの説明。

項目出現数=0は、値だけでなく項目名も省略することを表す。XMLスキーマにおける minOccurs, maxOccurs に相当。

項目が省略（項目出現数=0）された場合、または null値が指定された場合に適用されるデフォルト値。

データ型が number, int, long の場合、当パラメータの（IF仕様として規定する）最小/最大値と不等号（＞/≧/≦/＜）。データ型が string の場合に、当パラメータの（IF仕様として規定する）文字数の最小/最大値。

○は、項目が出現した場合で値に null を許容しないことを表す。null とは、JSON における null値、XMLにおける空要素を指す。

凡例 - 3


INDEX

シート名 IFID インタフェース名称IFバージョン

概要

1.00 共通情報4.0 すべてのIFに対して付与する共通的な要求情報を表す。

本リクエスト情報は、他のIFにて記載されるリクエスト情報内に配置される。

1.03

IF_XLB_R202

ファイル/フォルダ情報取得(メタ情報取得)

4.0

IDおよびパスによって指定されたファイル／フォルダの情報を取得する。

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

1.05 IF_XLB_R204 アップロード事前投入 4.0 IDおよびパスによって指定されたファイルのアップロード準備を行う。

1.06 IF_XLB_R205 アップロード 4.0 IDおよびパスによって指定されたファイルをアップロードする。

1.08 IF_XLB_R206 ダウンロード 4.0 IDおよびパスによって指定されたファイルを取得する。

1.09

IF_XLB_R207

ファイル、フォルダ削除

4.0 IDおよびパスによって指定されたファイル/フォルダ、リビジョンにてファイル/フォルダの論理削除を行う。削除対象がフォルダの場合、対象フォルダのメタ情報のみを返却する。削除対象が存在しない場合はエラーとする。

1.16 IF_XLB_R108ストレージ使用容量取得

3.0 クラウドストレージの使用容量を取得する。

1.10

IF_XLB_R208

ファイル/フォルダ移動(名前変更)

4.0 IDによって指定されたフォルダ・ファイルを指定のフォルダへ移動、または指定の名称で名前変更を行う。なお、　名前変更に伴うフォルダID・ファイルIDの変更は実施しない。　自領域内の移動は、フォルダID・ファイルIDを変更せず、親フォルダIDのみ変更する。

1.17 IF_XLB_R210 検索 4.0 パスによって指定されたファイルを検索する。

1.18 IF_XLB_R211 フォルダ作成 4.0 パスによって指定されたフォルダ配下に新規フォルダを作成する。

1.19 IF_XLB_R212 ファイル、フォルダ複製 4.0 IDおよびパスによって指定されたファイル／フォルダの情報を複製する。

1.23

IF_XLB_R213

データ全削除

4.0

当該ユーザのもつフォルダ、ファイルをすべて削除する。ただし、オーナーAPコードが入力された場合、該当オーナーAPコードが指定するアプリのフォルダ、ファイルのみを削除する。データ保管BOXアプリを除き、フォルダ、ファイルの全削除に成功した連携アプリフォルダの削除を行う。

コード定義 - コード定義 - IFで使用するコード定義の一覧

属性コード、各種状態コードの関係

属性コード、各種状態コードの関係

使用可能文字、使用禁止

使用可能文字、使用禁止文字

ユーザエージェント

ユーザエージェント

エラーコード一覧


エラーマッピング

エラーマッピング

HTTPステータスコードの返却優先度


INDEX - 4


- -

説明最小最大最小最大最小最大

文字列長設定値

Beanデータ型

項目出現数 null不可

省略時値数値

種別階層論理項目名物理項目名データ型

XML ROOT ELEMENT

項番

3 文字コード

レスポンス　基本情報項番項目名内容

1 出力形式

4 備考レスポンス返却時に、HTTP1.1で規定されるtransfer-codingに"chunked"を指定されることがあり得る。

レスポンス情報HTTP ステータス 200 意味正常備考全てのIFで正常終了した場合に返却する必要のあるパラメータ

Bean物理項目名

1 HTTPHeader

1 ユーザエージェント User-Agent string

2 Content-Type

2 HTTPHeader

1 (認証情報)アクセストークン及び関連情報

- - 1 1 ○

128 例） DOCOMO/2.0 SH-12C(AT;01.023.0100;Android;2.3.3;10)

別シート「ユーザエージェント」を参照※データ保管BOXへのアクセスには必須

1 1 ○ 16

数値文字列長設定値説明

最小最大最小最大最小最大データ型

Bean物理項目名

Beanデータ型


省略時値

リクエスト情報

項番種別階層論理項目名物理項目名

5 文字コード

6 備考

3 入力形式4 Content-Type

1 HTTPメソッド

2 リクエストURI

(r07) 共通情報

概要すべてのIFに対して付与する共通的な要求情報を表す。本リクエスト情報は、他のIFにて記載されるリクエスト情報内に配置される。

リクエスト　基本情報項番項目名内容

インタフェース仕様書

システム名インタフェースID

/インタフェース名称インタフェース

バージョン作成者作成日更新者更新日

データ保管BOX 4.0 2012/9/21 2014/1/29

1 HTTPHeader

1 データ保管BOXサーバヘッダ

X-PMCS string x-Pmcs String 1 1 ○ 2 2 "on"固定データ保管BOXサーバから返却される応答に付与される拡張ヘッダ。データ保管BOXサーバシステムに到達する前にエラーとなった場合は設定されない。

1.00 - 5


≧ ≦

自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

1 ○ 19 19 yyyy/mm/dd hh:mm:ss システム日付17 JSONElement

1検証日付

validation_date string validationDate String 1

1 ○ 19 19 yyyy/mm/dd hh:mm:ss ファイル：新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時フォルダ：フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時

15 JSONElement

3

更新日付

update_date string updateDate String 1

更新情報を管理する連番

14 JSONElement

3

共有状態種別コード

share_status_cd int shareStatusCd int 1 1 ○ 0 4 設定値の説明についてはコード定義シートを参照

int revision 1 ○13

○

UTF-8

Beanデータ型最小

parentFolderId

-

1

id 1 1

データ型物理項目名

int

String

○

1

Object

最大項目出現数

1

1

ファイル/フォルダを削除した要因を示す

12 JSONElement

3削除要因コード

delete_reason_cd int deleteReasonCd int 1 ○ 0 3 設定値の説明についてはコード定義シートを参照

1

JSONElement

3リビジョン

revision 1 21474836471

5 id

string

JSONElement

3ファイル/フォルダID

6 JSONElement

3 name

string

3 入力形式 Bodyなし

0 1 ○

11 JSONElement

long ○

10 JSONElement

1

削除状態コードdelete_status_cd int

size long

deleteStatusCd int3

size

種別コード

フォルダ・ファイルフルパス

2 リクエストURI https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/storageinfo/{path}

(r07)

概要IDおよびパスによって指定されたファイル／フォルダの情報を取得する。

REST リクエスト　基本情報項番項目名内容




バージョン作成者作成日

1 HTTPメソッド GET

更新者更新日

データ保管BOX IF_XLB_R202 4.0 2012/9/6 2013/5/8ファイル／フォルダ情報取得（メタ情報取得）

4 ボディのメディアタイプ要素無し

データ型Bean

物理項目名Bean

データ型項目出現数 null

不可省略時値


項番種別階層論理項目名物理項目名数値

5 文字コード UTF-8

6 備考

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

文字列長設定値説明

最小最大最小最大最小最大1 HTTP

Header- 認証情報詳細については「1.00」シートを参

照

XML ROOT ELEMENT

4 URIQuery

1 ファイル/フォルダID id string

属性コード attribute_cd string

JSON内容

application/json

id

1 設定値の説明についてはコード定義シートを参照

1 メタ情報リスト

5 URIQuery

1

RESTレスポンス　基本情報

備考

HTTP ステータス 200 意味

ボディのメディアタイプ文字コード

レスポンス情報

43

attributeCd String 0

出力形式

1

種別

parent_folder_id

2 メタ情報

JSONElement

metaInfoTotal

論理項目名

メタ情報のリスト

メタ情報

10

最小説明

指定の条件に該当するすべてのメタ情報件数

○ 1 2147483647

○

ルートフォルダの場合、もしくは被コラボ大元フォルダの場合はnull

2

項番項目名12

Bean物理項目名

項番階層

JSONElement

1 JSONElement

1 メタ情報総件数 meta_info_total int

- object

metaInfoList

4 3親フォルダID

string

3 JSONElement

ファイル/フォルダ管理のID

設定値最大

文字列長

親となるフォルダID10

1010

数値

ファイルまたはフォルダ名のフルパス

TOPフォルダの場合は空文字("name":"")を設定する。

1590

ファイルのハッシュ値（ハッシュ関数はMD5）フォルダの場合は存在しない

ファイルとフォルダを区別する。0 1 設定値の説明についてはコード定義シートを参照

32 32

状態コードstatus_cd

ファイル/フォルダの削除情報を示す

ファイル/フォルダの状態(お預かり済み)を示す。

9 JSONElement

3サイズ

1 0 3

○

ファイルのサイズフォルダの場合は存在しない

1

○

0 2^63-1

3 17

8 JSONElement

3

ハッシュ値

int

hash_value string

type_cd typeCd int

hashValue String

int

2 URIQuery

1 オーナーAPコード owner_ap_cd string

3

ownerApCd String

revFlg intURIQuery

1 再帰フラグ rev_flg int

1

n

3

JSONElement

設定値の説明についてはコード定義シートを参照

statusCd 設定値の説明についてはコード定義シートを参照

int

1

1 ○

○1

1

0 1

name String

ＩＦを発行したAPを特定するコード1 ○

0 1

取得対象となるファイル属性を示すコード

省略時：削除を含めたすべての情報を取得

1 ○ 説明欄参照

1

0

説明欄参照

0

ファイル/フォルダ管理のID例）　F123456789（ファイル）　D123456789（フォルダ）

任意項目となっておりますが、内部キャッシュなどでIDを保持している場合は、必ず指定してください。指定なしとした場合は、移動・名称変更に関するエラーコードの返却は行えません。

サブフォルダを参照するかを示すフラグ※第二階層以降も再帰フラグを持つ


1

10

String 1

最小最大

1

int

String

List

省略時値null不可

備考正常

○

8 8 設定値の説明についてはコード定義シートを参照

0 1

arraymeta_info_list

10

16 JSONElement

3

オブジェクト名称

object_name string objectName String 0 1 ○ 1 123 S3へのアクセス時に使用するオブジェクト名称

ファイルの場合のみ返却

1.03 - 6

https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/storageinfo/%7bpath%7d


≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

※その他異常系レスポンス情報は【別紙：エラーコード一覧】を参照※認証系の異常系レスポンス情報については、「1.00」シートを参照


13 JSONElement

2

更新日付


1 ○ 1 2147483647 更新情報を管理する連番11 JSONElement

2リビジョン

revision int revision int 1

1 ○ 0 3 設定値の説明についてはコード定義シートを参照


10 JSONElement


delete_reason_cd int deleteReasonCd int 1



9 JSONElement

2削除状態コード

delete_status_cd int deleteStatusCd int 1

1 ○ 設定値の説明についてはコード定義シートを参照


8 JSONElement

2状態コード

status_cd int statusCd int 1

1 ○ 0 2^63-1 ファイルのサイズフォルダの場合は存在しない

7 JSONElement

2サイズ

size long size long 0

1 ○ 32 32 ファイルのハッシュ値（ハッシュ関数はMD5）フォルダの場合は存在しない

6 JSONElement

2

ハッシュ値

hash_value string hashValue String 0


ファイルとフォルダを区別する。5 JSONElement

2種別コード

type_cd int typeCd int 1

ファイル/フォルダ管理のID

4 JSONElement

2 フォルダ・ファイルフルパス

name string name String 1 1 ○ 0 159 ファイルまたはフォルダ名のフルパス


親となるフォルダID

3 JSONElement


id string id String 1 1 ○ 10 10


メタ情報

2 JSONElement

2親フォルダID

parent_folder_id string parentFolderId String 1 1 10 10

HTTP ステータス 453 意味名前変更による該当情報なし（パス名）備考対象のファイル（フォルダ）のメタ情報のフォルダ名称が変更されている

XML ROOT ELEMENT

項番種別階層論理項目名物理項目名データ型Bean

物理項目名Bean


不可省略時値

数値文字列長設定値

レスポンス情報HTTP ステータス 405 意味名前変更による該当情報なし備考対象のファイル（フォルダ）のメタ情報の名称が変更されている

HTTP ステータス 410 意味対象とするファイル、フォルダが移動している備考対象とするフォルダ/ファイルのパスが変更されている場合

18 JSONElement

1

最終移動更新日時

move_date string moveDate String 1 1 19 19 yyyy/mm/dd hh:mm:ss 指定したフォルダ配下のフォルダ/ファイルが移動をした最終日付移動未実施の場合は、nullを設定する。

12 JSONElement

2共有状態種別コード


1JSONElement

1 ○11ObjectmetaInfoobjectmeta_infoメタ情報

1.03 - 7


≧ ≦

≧ ≦

≧ ≦

自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

update_date string updateDate String 1 1 ○

項目名

○

4 備考


HTTP ステータス 200 意味正常備考

JSONElement

1 出力形式 JSON内容

種別階層論理項目名

10 JSONElement

19 19 yyyy/mm/dd hh:mm:ss ファイル：新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時フォルダ：フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時

7 URIQuery

1 検証日付 validation_date string validationDate String 0

8 URIQuery

1


RESTレスポンス　基本情報項番

項番

3状態コード

status_cd int

XML ROOT ELEMENT

物理項目名データ型

2 JSONElement

1 メタ情報リスト meta_info_list array

5

1 1 表示件数

3 JSONElement

2 メタ情報 - object

3

(r07) ファイル／フォルダ差分情報取得

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


更新者更新日

データ保管BOX IF_XLB_R203 4.0 2012/9/6 2013/5/4インタフェース仕様書





2 リクエストURI https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/difference/{path}


項番種別階層論理項目名


6 備考

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

3 入力形式 Bodyなし4 ボディのメディアタイプ要素無し

物理項目名

3 URIQuery

1

2 URIQuery

8 8string ownerApCd String 1 1 ○


データ型Bean

物理項目名Bean


不可省略時値設定値

数値文字列長

ファイル/フォルダID id string id String 0 説明欄参照

4 URIQuery

1 リビジョン revision int

1 HTTPHeader

- 認証情報

10

1 オーナーAPコード owner_ap_cd

詳細については「1.00」シートを参照

差分取得対象のリビジョン番号revision int 1 1 ○

1 ○ 10

1 2147483647

表示件数 display_num int displayNum int 9999

revFlg int 0 1 ○ 0 1

1 ○


5 URIQuery

1 再帰フラグ rev_flg int

2 ボディのメディアタイプ application/json

0

URIQuery

1 属性コード string attributeCd String 0

0 1 ○ 説明欄参照

1

attribute_cd6

Bean物理項目名

数値文字列長最小最大最小

Beanデータ型


省略時値最大最小

4 JSONElement

3親フォルダID

parent_folder_id string parentFolderId

JSONElement

3

ファイル/フォルダID

8 JSONElement

6 JSONElement


name string

7 JSONElement

3種別コード

type_cd int

1 1 ○ 1

JSONElement

3 long


更新情報を管理する連番

string

9

hashValue String 0

delete_reason_cd int deleteReasonCd int

size long 0 1 ○ 0 2^63-1

○

サイズsize

String 1 1 ○id string

display_num int displayNum

ハッシュ値

hash_value


statusCd int 1 1

1 2147483647

○



revision int

1 1 0 3

0 3

19説明欄参照

String

- Object 0

int 1 1

metaInfoList List 1

1 1 10


ＩＦを発行したAPを特定するコード


任意項目となっておりますが、内部キャッシュなどでIDを保持している場合は、必ず指定してください。指定なしとした場合は、移動・名称変更に関するエラーコードの返却は行えません。


取得対象となるファイル属性を示すコード

省略時：削除を含めたすべての情報を取得

説明

1


サブフォルダを参照するかを示すフラグ※第二階層以降も再帰フラグを持つ

最大設定値

19



ファイルのハッシュ値（ハッシュ関数はMD5）フォルダの場合は存在しない

yyyy/mm/dd hh:mm:ss 有効期間超過チェックの対象日付指定なしの場合、検証日付チェックを行わない

返却件数の最大値取得結果がこの数値を超えていた場合はエラーとする。省略時:対象をすべて返却指定時:指定件数で返却




メタ情報

取得件数。

ファイルとフォルダを区別する。


10

159

15

11

13 JSONElement

3

12

JSONElement


JSONElement


JSONElement

3

更新日付

14 JSONElement

3


リビジョン

10


1 ○ 0 4

1

1 ○ 0 1

○

10

1 ○ 32 32


delete_status_cd int

revision int

share_status_cd int


deleteStatusCd int 1

shareStatusCd int 1


1 1

1 ○

n ○

typeCd int 1

name String

id

1.04 - 8

https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/difference/%7bpath%7d


　

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦



13 JSONElement

2

更新日付



2リビジョン




10 JSONElement





9 JSONElement





8 JSONElement

2状態コード



7 JSONElement

2サイズ


1 ○ 32 32 ファイルのハッシュ値（ハッシュ関数はMD5）

6 JSONElement

2ハッシュ値




2種別コード


1 ○ 1 159 ファイルまたはフォルダ名のフルパス

4 JSONElement


name string name String 1

1 ○ 10 10 ファイル/フォルダ管理のID3 JSONElement


id string id String 1

メタ情報

2 JSONElement

2親フォルダID

parent_folder_id string parentFolderId String 1 1 10 10 ルートフォルダの場合、もしくは被コラボ大元フォルダの場合はnull



1 JSONElement

1 メタ情報 meta_info object metaInfo Object 1 1 ○


XML ROOT ELEMENT


物理項目名Bean


不可省略時値




1 19 19 yyyy/mm/dd hh:mm:ss 指定したフォルダ配下のフォルダ/ファイルが移動をした最終日付移動未実施の場合は、nullを設定する。

17 JSONElement

1

最終移動更新日時

move_date string moveDate String 1

1 ○ 19 19 yyyy/mm/dd hh:mm:ss システム日付16 JSONElement

1検証日付

validation_date string validationDate String 1

12 JSONElement



1.04 - 9


≧ ≦

≧ ≦

自動選択

≧ ≦

≧ ≦


送信コンテンツ全体に対するハッシュ値。（ハッシュ関数はMD5）

String 1 1 ○ 32 32

2 JSONElement

1 分割No division_no int divisionNo

6 JSONElement

1 ハッシュ値 hash_value string hashValue

Bean物理項目名

4 備考



・新規にアップロードの場合は1。・再開の場合は処理が終わっていないデータの最小の分割Noを返却する。

1 1 ○ 1 2147483647


最小最大最小最大最小最大Bean


不可省略時値

数値XML ROOT ELEMENT

項番種別階層論理項目名物理項目名データ型

2 ボディのメディアタイプ application/json3 文字コード UTF-8

RESTレスポンス　基本情報項番項目名内容

1 出力形式 JSON

2147483647 新規アップロード時：指定しない更新アップロード時：指定する

revision int 0 1 説明欄参照


10 10

5 JSONElement


0 2^63-14 JSONElement

1 サイズ size long

1

アップロードするファイル全体のサイズ

size long 1 1 ○


UTF-8

6 備考

【リクエストURIに関する補足説明】{path}はアップロードするファイルのパス。長さは159文字を上限とする全角、半角に関わらず文字数としてカウントする。(データ保管BOXのルートからの絶対パス　"/"区切りで記述する)

1 HTTPHeader

- 認証情報

数値説明


Bean物理項目名

Beanデータ型


省略時値文字列長

設定値

更新者更新日





3 入力形式 JSON

1 HTTPメソッド POST

2 リクエストURI https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/preupload/{path}

string id String 0

int

(r07) アップロード事前投入

概要IDおよびパスによって指定されたファイルのアップロード準備を行う。





5 文字コード

ファイル管理のID例）　F123456789（ファイル）

新規アップロード時：指定しない更新アップロード時：指定する

1 JSONElement

1 一時ファイルID id string id String 1 1 ○ 10 10 ファイル管理の一時ID例）　T123456789（ファイル）

3 JSONElement

1 ファイルID id

2 JSONElement

1 オーナーAPコード owner_ap_cd string ownerApCd String 1 1 ○ 8 8 設定値の説明についてはコード定義シートを参照


3 JSONElement

1 分割サイズ division_size long divisionSize long 1 1 ○ 1 2^63-1 細分化したファイルの分割単位

1.05 - 10

https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/preupload/%7bpath%7d


≧ ≦

≧ ≦

自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦




削除要因コードdelete_reason_cd int deleteReasonCd int 1 1 ○

HTTP ステータス 201 意味正常備考最終要求時にリネーム処理が行われた場合に限り返却する。

12 JSONElement

2


share_status_cd int shareStatusCd int 1 1 ○ 0 4

10 JSONElement

2


13 JSONElement

2

更新日付



2リビジョン




9 JSONElement


delete_status_cd int deleteStatusCd int 1 1 ○ 0 3 設定値の説明についてはコード定義シートを参照


8 JSONElement

2状態コード


7 JSONElement

2サイズ




2種別コード


1 ○ 0 159 ファイルまたはフォルダ名のフルパスHTTPステータスが201の場合はリネームがされている

4 JSONElement

2

フォルダ・ファイルフルパス


1 ○ 10 10 ファイル/フォルダ管理のID例）　F123456789（ファイル）　D123456789（フォルダ）

3 JSONElement

2



1 10 10 ルートフォルダの場合、もしくは被コラボ大元フォルダの場合はnull

親となるフォルダID2 JSONElement

2親フォルダID

parent_folder_id string parentFolderId String 1

1 ○ メタ情報1 JSONElement

1 メタ情報 meta_info object metaInfo Object 0

1 1 2147483647 初回：'1.05アップロード事前投入時の返却値（分割ID）初回以降：前回設定値+1

5 URIQuery

1 分割No division_no int divisionNo int 1

Beanデータ型


省略時値数値文字列長

設定値説明最小最大最小最大最小最大

XML ROOT ELEMENT


物理項目名

3 文字コード UTF-84 備考


HTTP ステータス 200 意味正常備考以下メタ情報（meta_info）については、最終要求時に限り返却する。


1 出力形式 JSON2 ボディのメディアタイプ application/json

1 説明欄参照

1 2147483647 新規アップロード時：指定しない更新アップロード時：指定する

4 URIQuery

1 リビジョン revision int revision int 0


1 HTTPHeader

- 認証情報

6 備考

【リクエストURIに関する補足説明】{path}はアップロードするファイルのパス。長さは159文字を上限とする全角、半角に関わらず文字数としてカウントする。(データ保管BOXのルートからの絶対パス　"/"区切りで記述する)



物理項目名Bean


不可省略時値

数値最小最大最小最大

3 入力形式 Binaryデータ4 ボディのメディアタイプ application/octet-stream5 文字コード UTF-8

1 HTTPメソッド PUT

2 リクエストURI https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/storage/{path}

インタフェースバージョン

作成者

データ保管BOX IF_XLB_R205 4.0アップロード



/インタフェース名称

(r07)

概要IDおよびパスによって指定されたファイルをアップロードする。


作成日更新者更新日

2012/9/6 2013/5/1


最小最大

3 URIQuery

1 一時ファイルID id string id String 1 1 ○ 10 10 1.05事前アップロードの返却値（ファイルID）

ファイル管理の一時ID例）　T123456789（ファイル）

2 URIQuery

1 オーナーAPコード owner_ap_cd string ownerApCd String 1 1 ○ 8 8 設定値の説明についてはコード定義シートを参照


6 JSONElement

2ハッシュ値





1 ○

1.06 - 11

https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/storage/%7bpath%7d


≧ ≦

自動選択

自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦



13 JSONElement

2

更新日付



2リビジョン




10 JSONElement





9 JSONElement





8 JSONElement

2状態コード



7 JSONElement

2サイズ



6 JSONElement

2ハッシュ値




2種別コード



4 JSONElement






メタ情報

2 JSONElement

2親フォルダID




1 JSONElement



XML ROOT ELEMENT


物理項目名Bean


不可省略時値


3 文字コード UTF-84 備考




1 - - -



物理項目名Bean


不可省略時値

数値XML ROOT ELEMENT


4 備考


HTTP ステータス 200 意味正常備考正常の場合、返却値なし。HTTPステータスのみで判断する。

2 ボディのメディアタイプ application/octet-stream3 文字コード


1 出力形式 Binaryデータ

1.04　ファイル/フォルダ差分情報取得実施にて取得したリビジョンを指定

1 1 ○4 URIQuery


2 HTTPHeader

1 レンジ range string

1 2147483647

3 URIQuery



カンマ区切りの複数指定は認めない

範囲を指定して取得時：指定する範囲を指定しないで取得時：指定しない

0 1 説明欄参照

1 HTTPHeader

- 認証情報



Bean物理項目名

Beanデータ型


省略時値




6 備考

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




(r07) ダウンロード

概要IDおよびパスによって指定されたファイルを取得する。


更新者更新日





5 URIQuery

1 ファイルID id string id String 1 1 ○ 10 10 ファイル管理のID例）　F123456789（ファイル）


ＩＦを発行したAPを特定するコードownerApCd String 1 1 ○ 8

12 JSONElement



1.08 - 12



≧ ≦

自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦



XML ROOT ELEMENT


物理項目名Bean


不可省略時値


HTTP ステータス 417 意味リビジョン整合性エラーリビジョンが変化していた場合備考

HTTP ステータス 452 意味対象とするファイル、フォルダが見つからない（有効なし）備考対象のファイル（フォルダ）の有効なメタ情報が存在しない場合

405 意味名前変更による該当情報なし（ファイル名）備考対象のファイル（フォルダ）のメタ情報のファイル名称が変更されている場合対応外のHTTPメソッドを利用してアクセスされた場合


HTTP ステータス 409 意味状態コードエラー備考対象のフォルダ・ファイルが操作可能な状態でない場合

HTTP ステータス 404 意味対象とするファイル、フォルダが見つからない（存在なし）備考対象のファイル（フォルダ）のメタ情報が物理的に存在しない場合

HTTP ステータス

n ○


10

1 JSONElement

メタ情報3 JSONElement

2 メタ情報 - object - Object 1

1 メタ情報総件数 meta_info_total int metaInfoTotal int 1 1 ○ 1

5 JSONElement

リクエストで指定されたすべてのメタ情報件数

2 JSONElement

1 メタ情報リスト meta_info_list array metaInfoList List 1 1 ○ メタ情報のリスト

6 JSONElement

3 フォルダ/ファイルフルパス

name string 1

3 ファイル/フォルダID id string id String 1

2 削除対象情報 - object - Object 1



12 JSONElement



1 ○ 0 311

ファイル：新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時フォルダ：フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時

15 JSONElement

3

更新日付

update_date string updateDate String 1 1 ○ 19 19 yyyy/mm/dd hh:mm:ss

更新情報を管理する連番13 JSONElement

3リビジョン

revision int revision int 1 1 ○ 1 2147483647





JSONElement

3状態コード


int deleteStatusCd int 1

○

JSONElement

3


9 JSONElement

3サイズ

size long size long 0 1 ○ 0 2^63-1



3種別コード



6 JSONElement



5 JSONElement

3



4 JSONElement

3親フォルダID


XML ROOT ELEMENT

項番種別階層論理項目名物理項目名データ型最小

4 備考



3 JSONElement




1 削除対象情報リスト delete_info_list array deleteInfoList List 1

4 JSONElement


7 JSONElement

説明欄参照

1 指定しない：リビジョンをチェックせず削除指定する：リビジョンをチェックして削除

3 リビジョン int 0 1


データ型Bean

物理項目名Bean


不可省略時値


2 JSONElement



1 HTTPHeader

- 認証情報

1 オーナーAPコード owner_ap_cd

6 備考

【リクエストURIに関する補足説明】{path}は削除対象となるフォルダ/ファイルの親フォルダまでのパス。長さは159文字を上限とする全角、半角に関わらず文字数としてカウントする。　データ保管BOXのルートからの絶対パス　"/"区切りで記述する

3 入力形式 JSON4 ボディのメディアタイプ application/json5 文字コード UTF-8

更新者更新日

データ保管BOX IF_XLB_R207 4.0 2012/9/4 2013/5/10ファイル、フォルダ削除


(r07)

概要IDおよびパスによって指定されたファイル/フォルダ、リビジョンにてファイル/フォルダの論理削除を行う。削除対象がフォルダの場合、対象フォルダのメタ情報のみを返却する。削除対象が存在しない場合はエラーとする。







revision int revision

削除対象情報のリスト

1000 ○

1 ○

削除対象情報

1 ○

最小

32

string ownerApCd String 1 1 ○


省略時値

1 ○

1 ○ 10


2147483647


最大

ファイルのハッシュ値（ハッシュ関数はMD5）

10 10 ルートフォルダの場合、もしくは被コラボ大元フォルダの場合はnull


10 10 ファイル/フォルダ管理のID例）　F123456789（ファイル）　D123456789（フォルダ）

説明

2147483647

10 ファイル/フォルダ管理のID例）　F123456789（ファイル）　D123456789（フォルダ）

削除対象のファイル/フォルダの名称（フルパス）

詳細は「使用可能文字、使用禁止文字について」を参照

1 159

32



最小最大

8 JSONElement

3ハッシュ値


Bean物理項目名

Beanデータ型

1

14 JSONElement

数値最大

3


share_status_cd int shareStatusCd int 1

1 ○

1

1 ○ 0

削除状態コードdelete_status_cd

1.09 - 13




ファイル/フォルダ管理のIDリクエストのファイル/フォルダIDの中でエラーが発生したものが返却される。

1 JSONElement

1



1.09 - 14


≧ ≦

自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

3 移動前情報 - object - Object 1 1000 ○


14 JSONElement

3




3リビジョン




12 JSONElement





11 JSONElement





10 JSONElement

3状態コード



9 JSONElement

3サイズ



8 JSONElement

3ハッシュ値




3種別コード



6 JSONElement



1 ○ 10 10 ファイル/フォルダ管理のID例）　F123456789（ファイル）　D123456789（フォルダ）

- object - Object 1

5 JSONElement

3



4 JSONElement

3親フォルダID


3

1 10 10 ルートフォルダの場合、もしくは被コラボ大元フォルダの場合はnull


1

n ○

リクエストで指定されたすべてのメタ情報件数

1 ○ メタ情報のリスト

メタ情報

21474836471 1 meta_info_total int metaInfoTotal int ○

項番項目名内容1

備考4

出力形式

JSONElement

メタ情報総件数 1 11

意味正常備考

最小最大Bean

物理項目名最小最大最小最大


HTTP ステータス 200

XML ROOT ELEMENT

項番Bean

データ型種別階層論理項目名物理項目名データ型

2 JSONElement

1 メタ情報リスト meta_info_list array metaInfoList List

string 移動（名前変更）前ファイル/フォルダの名称（フルパス）※フォルダ名の変更の場合、パスの最下層の名称を対象とする。


JSONElement

2 メタ情報

説明項目出現数 null

不可省略時値


フォルダ/ファイルの更新情報を管理する連番

RESTレスポンス　基本情報

JSON2 ボディのメディアタイプ application/json

文字コード UTF-8

9

beforeInfo Object6 JSONElement

1 移動（名前変更）前情報

before_info object

JSONElement

4 フォルダ/ファイルID id string

7 JSONElement

2 移動前情報リスト before_info_list array beforeInfoList List

8 JSONElement

11 JSONElement

4 リビジョン revision int 1 2147483647

159

1 1 ○

revision int 1 1 ○

1 1 ○

JSONElement


name

10

1 11 ○

id String 1 1 ○

159

10

ファイル/フォルダ管理のID（移動するフォルダ/ファイルID）例）　F123456789（ファイル）　D123456789（フォルダ）

フォルダ管理のID（格納先フォルダID）※移動の場合に限り必須※名称変更の場合は指定しない例）　D123456789（フォルダ）

名称変更時：指定しない移動時：指定する

移動前情報のリスト移動の場合のみ複数設定できる。移動前情報

10

3 JSONElement

1 移動（名前変更）後情報

after_info object


name stringJSONElement

4 JSONElement

2 1 10説明欄参照

afterInfo

6 備考

数値

1 8

1 HTTPHeader

- 認証情報

○2 JSONElement

データ型Bean

物理項目名Bean


不可省略時値


項番種別階層論理項目名物理項目名最小最大





(r07)

概要IDによって指定されたフォルダ・ファイルを指定のフォルダへ移動、または指定の名称で名前変更を行う。なお、　名前変更に伴うフォルダID・ファイルIDの変更は実施しない。　自領域内の移動は、フォルダID・ファイルIDを変更せず、親フォルダIDのみ変更する。

更新者更新日

データ保管BOX IF_XLB_R208 4.0 2012/9/6 2013/5/10ファイル/フォルダ移動(名前変更)




2 リクエストURI https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/move3 入力形式 JSON4 ボディのメディアタイプ application/json


最大最小最大最小詳細については「1.00」シートを参照

8

Object 1 1 ○

10

3


ＩＦを発行したAPを特定するコード1 オーナーAPコード owner_ap_cd string ownerApCd String 1

1 1 ○ 移動（名前変更）後ファイル/フォルダの名称（フルパス）※移動の場合は移動先親フォルダまでのフルパスが設定される。


TOPフォルダを指定する場合は空文字("name":"") を指定する。

5

フォルダID id string id String 0

1.10 - 15

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



ファイル/フォルダ管理のIDリクエストのファイル/フォルダIDの中でエラーが発生したものが返却される。


1 JSONElement

1



HTTP ステータス 594 意味フォルダ配下のフォルダ・ファイル数上限到達備考アップロード、フォルダ作成、フォルダ・ファイル複製に伴い、指定フォルダ配下でお預かり済みとなっているメタ情報が上限（外部定義）に到達した場合

XML ROOT ELEMENT


物理項目名Bean


不可省略時値


HTTP ステータス 452 意味対象とするファイル、フォルダが見つからない（有効なし）備考対象のファイル（フォルダ）の有効なメタ情報が存在しない場合


HTTP ステータス 405 意味名前変更による該当情報なし（ファイル名）備考対象のファイル（フォルダ）のメタ情報のファイル名称が変更されている場合対応外のHTTPメソッドを利用してアクセスされた場合


HTTP ステータス 409 意味状態コードエラー備考対象のフォルダ・ファイルが操作可能な状態でない場合

備考対象のファイル（フォルダ）のメタ情報が物理的に存在しない場合


15 JSONElement

3

更新日付


HTTP ステータス 404 意味対象とするファイル、フォルダが見つからない（存在なし）


HTTP ステータス 413 意味ストレージ容量超過エラー備考ストレージ容量を超過してしまう場合リクエスト・エンティティが大きすぎる場合

HTTP ステータス 423 意味重複エラー備考対象のフォルダ・ファイルが既に存在している場合

HTTP ステータス 414 意味パス長超過エラー対象とするフォルダ・ファイルのフルパス長が最大長を超えた場合

HTTP ステータス 417 意味リビジョン整合性エラーリビジョンが変化していた場合

備考

備考

1.10 - 16


自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

(r07) ストレージ使用容量取得

概要クラウドストレージの使用容量を取得する。


更新者更新日

データ保管BOXIF_XLB_R108 3.0 2012/9/13 2012/10/30





3 入力形式 Bodyなし4 Content-Type 要素なし


2 リクエストURI https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/3.0/capacityinfo




6 備考


データ型Bean

物理項目名Bean


不可省略時値

1 HTTPHeader

- 認証情報



3

2

#VALUE!

2 Content-Type application/json3 文字コード UTF-8


1 出力形式 JSON

XML ROOT ELEMENT


4 備考

レスポンス情報HTTP ステータス 200 意味正常備考

1 JSONElement

1 契約容量 capacity long



物理項目名Bean


不可省略時値

数値

0 2^63-1 契約容量(byte)1 1 ○

データ保管BOX使用容量(byte)1 1 ○

3 JSONElement

1 その他サービス使用容量

other_used long


1 データ保管BOX使用容量

box_used long

0 2^63-1 その他サービス使用容量(byte)1 1 ○

空き容量(byte)1 1 ○

5


1 空き容量 unused long

1.16 - 17

https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/3.0/capacityinfo


自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

2147483647

ファイル：新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時フォルダ：フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時


19 19 yyyy/mm/dd hh:mm:ss

12

2 JSONElement

1

○ 0 3

1 1 ○ 0

11

○ 0

○


10 JSONElement

3状態コード

status_cd int statusCd 設定値の説明についてはコード定義シートを参照


2^63-1

1 1 ○

0 1

1


JSONElement


delete_status_cd int deleteStatusCd int 1 01 ○ 設定値の説明についてはコード定義シートを参照

3



更新情報を管理する連番○ 1

JSONElement

3種別コード

type_cd int typeCd

8 JSONElement

3ハッシュ値

hash_value string

14

13 JSONElement

3リビジョン

5 id String 1

6 JSONElement



JSONElement

shareStatusCd int

int 1

7

1 ○

revision int revision

9 JSONElement

3サイズ

15 JSONElement

3

更新日付

update_date string updateDate String

JSONElement

3


share_status_cd int

検索対象(ファイル、フォルダ)用の文字列。


searchStr String 1 1 ○3 JSONElement

1 検索文字列 search_str string 1 159

1 HTTPHeader

- 認証情報


ＩＦを発行したAPを特定するコードownerApCd String 1 1 ○ 8



項番種別階層論理項目名物理項目名数値文字列長

設定値

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

2012/9/6

データ型Bean

物理項目名Bean


不可省略時値

1 HTTPメソッド

作成日

6 備考

【リクエストURIに関する補足説明】{path}は検索の起点となるパス。長さは159文字を上限とする。全角、半角に関わらず文字数としてカウントする。{path}が設定されない場合、ルートフォルダが検索の起点となる

3 入力形式 JSON4 ボディのメディアタイプ application/json5 文字コード UTF-8

概要パスによって指定されたファイルを検索する。


POST

2 リクエストURI

2013/5/1検索




バージョン作成者更新者更新日

データ保管BOXIF_XLB_R210 4.0

(r07)

備考UTF-8

ボディのメディアタイプ application/json

string 8 設定値の説明についてはコード定義シートを参照

JSON

XML ROOT ELEMENT

オーナーAPコード owner_ap_cd

3 文字コード

正常

2 JSONElement

1

1 JSONElement

1 metaInfoTotal int

種別階層論理項目名物理項目名データ型Bean

物理項目名Bean

データ型1メタ情報総件数 meta_info_total

備考

RESTレスポンス　基本情報項番項目名

1 出力形式

4

レスポンス情報HTTP ステータス 200 意味

2

内容

int最大

null不可

省略時値数値

項番最小項目出現数

検索対象の範囲条件を示すコード。本IFに関してはD指定のみを許容する

4 JSONElement

1 属性コード attribute_cd string attributeCd String 1 1 ○ 説明欄参照



id string

string parentFolderId String

32

1

10

1

1

1 ○ 1

4 JSONElement

3親フォルダID

3 JSONElement

2 メタ情報 -

parent_folder_id

説明文字列長

設定値

指定の条件に該当するすべてのメタ情報件数

メタ情報

10 10

10

最小最大最小0 2147483647

レスポンス情報HTTP ステータス 416 意味検索結果上限エラー備考検索結果が50件を超えた場合

XML ROOT ELEMENT


物理項目名Bean

データ型項目出現数文字列長


null不可

省略時値数値

ファイルのハッシュ値（ハッシュ関数はMD5）



32○

○


159 ファイルまたはフォルダ名のフルパス



1

1

int

メタ情報リスト meta_info_list

int

3

hashValue String 0

object - Object 0 n

array metaInfoList List 1

size long size long

1

0

JSONElement

1

削除要因コードdelete_reason_cd int deleteReasonCd int 1 1

1

3

1

○

最大


1

○

1 JSONElement

1 メタ情報総件数 meta_info_total int metaInfoTotal int 1 1 ○ 0 2147483647 指定の条件に該当するすべてのメタ情報件数

2 JSONElement

1 メタ情報リスト meta_info_list array metaInfoList List 1 1 メタ情報のリスト

3 JSONElement

2 メタ情報 - object - Object 50 50 ○ メタ情報

4 JSONElement

3親フォルダID



5 JSONElement

3


id string id String 1 1 ○ 10 10 ファイル/フォルダ管理のID例）　F123456789（ファイル）　D123456789（フォルダ）

6 JSONElement


name string name String 1 1 ○ 1 159 ファイルまたはフォルダ名のフルパス

7 JSONElement

3種別コード

type_cd int typeCd int 1 1 ○ 0 1 設定値の説明についてはコード定義シートを参照


8 JSONElement

3ハッシュ値

hash_value string hashValue String 0 1 ○ 32 32 ファイルのハッシュ値（ハッシュ関数はMD5）

9 JSONElement

3サイズ

size long size long 0 1 ○ 0 2^63-1 ファイルのサイズフォルダの場合は存在しない

10 JSONElement

3状態コード

status_cd int statusCd int 1 1 ○ 設定値の説明についてはコード定義シートを参照


11 JSONElement




12 JSONElement


delete_reason_cd int deleteReasonCd int 1 1 ○ 0 3 設定値の説明についてはコード定義シートを参照


13 JSONElement

3リビジョン

revision int revision int 1 1 ○ 1 2147483647 更新情報を管理する連番

14 JSONElement

3



15 JSONElement

3

更新日付

update_date string updateDate String 1 1 ○ 19 19 yyyy/mm/dd hh:mm:ss ファイル：新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時フォルダ：フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時

1.17 - 18

https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/search/%7bpath%7d



1.17 - 19


自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦




8 JSONElement



更新情報を管理する連番revision int 1 1 ○ 1 2147483647

0 設定値の説明についてはコード定義シートを参照設定値の説明についてはコード定義シートを参照

1


7 JSONElement




1 ○

1

9 JSONElement

2リビジョン

5 JSONElement

2種別コード

JSONElement

2状態コード


int 1 1 ○

10 10 フォルダ管理のID



159 フォルダ名のフルパス


1 JSONElement

1 メタ情報 meta_info object

4 JSONElement

2フォルダフルパス

name string

String 1 1

メタ情報

○

null不可

省略時値数値

metaInfo Object 1

revision int

3 JSONElement

2フォルダID

id string id

6

name

type_cd int typeCd

String 1 1 ○


2 JSONElement

2親フォルダID

parent_folder_id string parentFolderId String

1 ○最大最小最大最小最大

1

XML ROOT ELEMENT

項番種別階層論理項目名物理項目名データ型最小

Bean物理項目名

Beanデータ型

項目出現数



1 出力形式 JSON




1 HTTPHeader

- 認証情報



Bean物理項目名

Beanデータ型


省略時値




6 備考

【リクエストURIに関する補足説明】{path}は作成するフォルダのパス。長さは159文字を上限とする全角、半角に関わらず文字数としてカウントする。　データ保管BOXのルートからの絶対パス　"/"区切りで記述する

3 入力形式 JSON4 ボディのメディアタイプ application/json


2 リクエストURI https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/create/{path}

(r07) フォルダ作成

概要パスによって指定されたフォルダ配下に新規フォルダを作成する。


更新者更新日





説明

1

2 JSONElement

1 オーナーAPコード owner_ap_cd string ownerApCd String 1


4 備考


11 JSONElement

2

更新日付

update_date string updateDate String 1 1 ○ 19 19 yyyy/mm/dd hh:mm:ss ファイル：新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時フォルダ：フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時

10 JSONElement

2



1.18 - 20

https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/create/%7bpath%7d


≧ ≦

自動選択

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

メタ情報


1 JSONElement



XML ROOT ELEMENT


物理項目名Bean


不可省略時値




複製元のファイル/フォルダの名称（フルパス）


9 JSONElement

2 リビジョン revision int revision int 1 1 ○ 1 2147483647 フォルダ/ファイルの更新情報を管理する連番

8 JSONElement


name string 1

7 JSONElement

2 フォルダ/ファイルID id string id String 1 1 ○ 10 10 ファイル/フォルダ管理のID（複製するフォルダ/ファイルID）例）　F123456789（ファイル）　D123456789（フォルダ）

6 JSONElement

1 複製元情報 before_info object beforeInfo Object 1 1 ○

1 ○ 0 159 複製先のフォルダの名称（フルパス）


TOPフォルダを指定する場合は空文字("name":"") を指定する。

5 JSONElement

2 フォルダフルパス name string 1

1 ○ 10 10 フォルダ管理のID（格納先フォルダID）例）　D123456789（フォルダ）

4 JSONElement

2 フォルダID id string id String 1

1 ○3 JSONElement

1 複製先情報 after_info object afterInfo Object 1





データ保管BOX IF_XLB_R212 4.0 2012/10/29 2013/5/1


2 リクエストURI https://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/copy

(r07) ファイル、フォルダ複製

概要IDおよびパスによって指定されたファイル／フォルダの情報を複製する。



6 備考

3 入力形式 JSON4 ボディのメディアタイプ application/json

データ型Bean

物理項目名Bean


不可省略時値


項番種別階層論理項目名物理項目名数値文字列長



2 JSONElement


1 HTTPHeader

- 認証情報


ＩＦを発行したAPを特定するコードownerApCd String 1 1 ○




4 備考


設定値説明最小最大最小最大最小最大項目出現数 null

不可省略時値

数値

メタ情報（複製先）metaInfo Object 1 1 ○

2 JSONElement

2親フォルダID

parent_folder_id string

1 JSONElement

1 メタ情報 meta_info object


親となるフォルダIDparentFolderId String 1 1

4 JSONElement


name

10 ファイル/フォルダ管理のIDid String 1 1 ○ 103 JSONElement


id string


name String 1 1 ○string 1

6 JSONElement

2ハッシュ値

hash_value


ファイルとフォルダを区別する。typeCd int 1 1 ○ 0 1int

ファイルのハッシュ値（ハッシュ関数はMD5）ファイルのサイズフォルダの場合は存在しない

size long 0 1 ○ 0 2^63-1

deleteReasonCd int 1 1 ○

JSONElement

2状態コード

status_cd int statusCd int 1 1 ○






0 3

更新情報を管理する連番revision int 1 1 ○ 1 2147483647

159

Bean物理項目名

Beanデータ型

文字列長

3232

1 1 ○

hashValue String 0 1 ○


deleteStatusCd int

159

13 JSONElement

2

1 ○ 1

7 JSONElement

2サイズ

size long

string

8

int

10 JSONElement


delete_reason_cd int

12 JSONElement

2



XML ROOT ELEMENT


11 JSONElement

2リビジョン

revision int

9 JSONElement


delete_status_cd

5 JSONElement

2種別コード

type_cd

更新日付



19 yyyy/mm/dd hh:mm:ss ファイル：新規及び更新アップロードが完了した日時、複製先ファイルは複製が完了した日時フォルダ：フォルダ作成が完了した日時、もしくは、複製先フォルダは複製が完了した日時

19

1 ○ 0 4

1 ○

1.19 - 21

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


≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦

≧ ≦



13 JSONElement

2

更新日付



2リビジョン




10 JSONElement





9 JSONElement





8 JSONElement

2状態コード



7 JSONElement

2サイズ



6 JSONElement

2ハッシュ値




2種別コード



4 JSONElement






2 JSONElement

2親フォルダID



12 JSONElement



1.19 - 22


自動選択


ＩＦを発行したAPを特定するコード2 URIQuery

1 オーナーAPコード owner_ap_cd string ownerApCd String 1

1 - - -

null不可

省略時値数値文字列長



削除対象となるAPを特定するコード

RESTレスポンス　基本情報項目名内容

出力形式 Bodyなし2 ボディのメディアタイプ要素無し1

3 URIQuery

1

要求先オーナーAPコード

target_owner_ap_cd string targetOwnerApCd String 0 1 ○ 説明欄参照

8 8 00000000は非許容


物理項目名データ型Bean

物理項目名

1 HTTPHeader

- 認証情報



4 備考

項目出現数Beanデータ型

項番



Bean物理項目名

Beanデータ型


省略時値

XML ROOT ELEMENT

項番種別階層論理項目名




6 備考



2 リクエストURIhttps://xlb.datastoragebox.smt.docomo.ne.jp/box_a2/4.0/delete_all

(r07) データ全削除

概要当該ユーザのもつフォルダ、ファイルをすべて削除する。ただし、オーナーAPコードが入力された場合、該当オーナーAPコードが指定するアプリのフォルダ、ファイルのみを削除する。データ保管BOXアプリを除き、フォルダ、ファイルの全削除に成功した連携アプリフォルダの削除を行う。






データ保管BOXIF_XLB_R213 4.0 2012/10/17 2013/5/1

1.23 - 23


システム名作成者作成日更新者更新日データ保管BOX 2012/10/15 2014/1/29

名称コード意味再帰フラグ 0 OFF：再帰的な取得処理を実施しない

1 ON：再帰的な取得処理を実施する属性コード (無指定) すべて：削除を含めたすべてのメタ情報を

取得する。D 削除を除く：削除を除いたメタ情報を取得

する。※削除とは、削除状態コードが「未削除」以外のものを指す。

種別コード 0 フォルダ1 ファイル

状態コード 0 お預かり済み

1 処理中

2 アップロード待機3 アップロード中

削除状態コード 0 未削除1 論理削除2 論理削除復活不可3 物理削除済み

削除要因コード 0 未削除1 ユーザ削除2 容量変更3 著作権侵害4 複製中5 移動中(移動元)6 移動中(移動先)

オーナーAPコード ******** 各アプリごとに数値8桁固定で払い出されるコード

共有状態種別コード0 共有なし

1 共有（参照・保存のみ）配下共有（参照・保存のみ）（*1）されているフォルダの配下に配置されている状態を表す。2 共有（編集可）配下共有（編集可）（*2）されているフォルダの配下に配置されている状態を表す。3 共有（参照・保存のみ）4 共有（編集可）共有（編集可）フォルダに設定されている状態を表す。

（*1～*2）データ保管BOXアプリからのみ実行できる「共有」機能の各操作。「共有」中のファイル／フォルダに対しては、一部操作が制限される。（*1）共有（参照・保存のみ）…ファイル／フォルダをURLで共有する機能。共有されたユーザはデータの参照・保存のみ可能。（*2）共有（編集可）…データ保管BOXを利用しているユーザ間でフォルダを共有する機能。共有されたユーザはデータの参照・保存・編集が可能。

ファイルかフォルダかを示す。

削除されていない状態を示す。

コード一覧

備考メタ情報取得時の再帰的な処理を実施するか否かを示す。メタ情報取得範囲については、「メタ情報取得範囲」のシートを参照。

メタ情報取得時の取得対象範囲を示す。メタ情報取得対象については、「メタ情報取得範囲」のシートを参照。

すべての操作受付を許可する状態です。「フォルダ・ファイル複製」実施中の状態です。

アップロード事前投入IFを正常終了した状態です。

論理削除された対象がオーダ取消によって復帰しない状態を示す。

削除されていない状態を示す。通常の論理削除状態を示す。

アップロードIFを実施中の状態です。

物理削除状態を示す。

ユーザ跨りの移動処理中の状態を示す。(移動先)

共有（参照・保存のみ/編集可）されていない状態を表す。ただし、共有されているファイルまたはフォルダの上位フォルダである場合も含まれる。

共有（参照・保存のみ）ファイルまたはフォルダに設定されている状態を表す。

ユーザ操作により削除された状態を示す。容量削減オーダを受け削除された状態を示す

アプリケーションを特定する。8桁の通番で払い出しする。

'著作権チェックによりエラーとなり削除された状態を示す。複製処理中の状態を示す。ユーザ跨りの移動処理中の状態を示す。(移動元)

コード定義 - 24


別紙：ファイル／フォルダ情報取得（メタ情報取得）、ファイル／フォルダ差分情報取得、検索における属性コードについて

1.03(ファイル／フォルダ情報取得（メタ情報取得）、1.04(ファイル／フォルダ差分情報取得)、1.17(検索)の際、指定可能なパラメータである　属性コード　返却されるメタ情報の関係を以下に示します。

備考

コード名称コード値（和名）分類

指定なし

(

全て

)

D

（削除を除く

）お預かり済み - ○ ○処理中 - ○ ○

新規アップロード - -更新アップロード ○ ○ ※変更前の情報を返却新規アップロード - -更新アップロード ○ ○ ※変更前の情報を返却

未削除 - ○ ○論理削除 - ○ -論理削除復活不可 - ○ -物理削除 - ○ -未削除 - ○ ○ユーザ削除 - ○ -容量変更 - ○ -著作権侵害 - ○ -

複製中 - ○ ○サーバー側の内部処理にて利用しているため削除状態コードとしては未削除

移動中(移動元) - ○ ○サーバー側の内部処理にて利用しているため削除状態コードとしては未削除

移動中(移動先) - ○ ○サーバー側の内部処理にて利用しているため削除状態コードとしては未削除

※メタ情報差分取得では指定されたリビジョンより大きな値をもつレコードを返却対象とします。　　そのうえで属性コードの設定値にしたがい返却対象の絞り込みを行います。※属性コードは複数の値を設定可能とする（将来的な設計であり、今回は不要）

削除要因コード

削除状態コード

属性コード

状態コード

返却されるメタ情報

アップロード待機

アップロード中

属性コード、各種状態コードの関係 - 25


　1.データ保管BOXサーバにおける各種文字の扱いについての基本方針

基本方針について下記の通りとする。

項番

1

2

3

表1　許容文字の半角スペース

項番 Unicode JIS X 0213 文字参照名称

ノーブレークスペース

（改行を行わないスペース）

&ensp; enスペース

（en幅のスペース）

&emsp; emスペース

（em幅のスペース）

フィギュアスペース

（等幅フォントの半分の幅）

約物スペース

（約物と同幅で横幅が狭い）

ヘアスペース

（非常に小さいスペース）

　表意文字スペース

　（和字間隔、俗に全角スペース）

幅なしスペース（幅が0）

14 U+FEFF - 幅なし改行なしスペース

12 U+200B -

13 U+3000 -

使用可能文字、使用禁止文字について

本シートの構成は以下の通りである。

1.データ保管BOXサーバにおける各種文字の扱いについての基本方針データ保管BOXサーバ全体の文字コードチェックの基本方針を説明する。

2.データ保管BOXにおける文字コードチェック指針(2バイト以上の文字が入り得る項目のチェック指針)データ保管BOXにおける2バイト以上の文字が入り得る項目について、データ保管BOXサーバ全体の方針を前提とした上で、特殊な扱いをするものについて説明する。

3.データ保管BOXにおける文字コードチェック指針(1バイトの文字コード)データ保管BOXにおける1バイトの文字が入る項目について、データ保管BOXサーバ全体の方針を前提とした上で、特殊な扱いをするものについて説明する。

項番1に記載しているもの以外の文字（改行コードなどの制御文字や、JISX0213により追加となるもの、サロゲートペア）は、特定文字「□（トウフ）」に変換する。改行コードについては、CR、LFそれぞれを１つの「□（トウフ）」に変換する。

メッセージ等、改行コードが入力される項目については、改行コードを許容する。改行コードは、CR、LF、CRLFを対象とする。

1 U+0020 - （半角スペース）

基本指針

JISX0201（ラテン）＋JISX0201（半角カナ）＋JISX0208(但し未定義領域は除く)＋特別許容文字+半角スペースを許容文字とする。半角スペースとみなすコードについては「表1　許容文字の半角スペース」を、特別許容文字は「表2特別許容文字」を参照。半角スペースは、文字化けを防ぐ為全て0x20（UTF-8）コードに変換する。

（emの1/5幅のスペース）

U+200A -

8 U+2006 -

9 U+2007 -

11

U+2008 -

-7 U+2009

2 U+00A0 1 - 9 - 2

3 U+2002 -


4 U+2003 -

6 U+2005 - （emの1/4幅のスペース）

5 U+2004 -


10

使用可能文字、使用禁止文字 - 26


表2　特別許容文字

項番文字文字コード（UTF-8）

1 ⅰ 0xE285B0

2 ⅱ 0xE285B1

3 ⅲ 0xE285B2

4 ⅳ 0xE285B3

5 ⅴ 0xE285B4

6 ⅵ 0xE285B5

7 ⅶ 0xE285B6

8 ⅷ 0xE285B7

9 ⅸ 0xE285B8

10 ⅹ 0xE285B9

11 ① 0xE291A0

12 ② 0xE291A1

13 ③ 0xE291A2

14 ④ 0xE291A3

15 ⑤ 0xE291A4

16 ⑥ 0xE291A5

17 ⑦ 0xE291A6

18 ⑧ 0xE291A7

19 ⑨ 0xE291A8

20 ⑩ 0xE291A9

21 ⑪ 0xE291AA

22 ⑫ 0xE291AB

23 ⑬ 0xE291AC

24 ⑭ 0xE291AD

25 ⑮ 0xE291AE

26 ⑯ 0xE291AF

27 ⑰ 0xE291B0

28 ⑱ 0xE291B1

29 ⑲ 0xE291B2

30 ⑳ 0xE291B3

31 Ⅰ 0xE285A0

32 Ⅱ 0xE285A1

33 Ⅲ 0xE285A2

34 Ⅳ 0xE285A3

35 Ⅴ 0xE285A4

36 Ⅵ 0xE285A5

37 Ⅶ 0xE285A6

38 Ⅷ 0xE285A7

39 Ⅸ 0xE285A8

40 Ⅹ 0xE285A9

41 ◦ 0xE297A6

42 • 0xE280A2

43 – 0xE28093

44 \ 0xC2A5

45 ～ 0xEFBD9E

46 ∥ 0xE288A5



　2.データ保管BOXにおける文字コードチェック指針(2バイト以上の文字が入り得る項目のチェック指針)

2バイト以上の文字が入り得る項目の扱いについて以下の通りとする。

・サーバ側の文字コードのチェック指針：「表3　データ保管BOX文字コードチェック指針」参照

・サーバ側の使用禁止文字：「表4　データ保管BOX使用禁止文字」参照

・入力を許容しないwindowsの予約語：「表5　windowsの予約語」参照。入力された文字列が所定の予約語と大文字・小文字を区別せず、一致した場合にエラーを返却する。

表3　データ保管BOX文字コードチェック指針

項番チェック対象

1 ニックネーム

2ファイル名、フォ

ルダ名

3 検索文字列

4 メッセージ

53rdPartyアプリ

名

表4　データ保管BOX使用禁止文字

項番対象文字文字コード（UTF-8）備考

1 | 0x7C

2 ｜ 0xEFBD9C

3 ¢ 0xC2A2

4 ￠ 0xEFBFA0

5 £ 0xC2A3

6 ￡ 0xEFBFA1

7 ¬ 0xC2AC

8 ￢ 0xEFBFA2

9 ∥ 0xE288A5

10 ‖ 0xE28096

11 − 0xE28892

12 － 0xEFBC8D

13 ～ 0xEFBD9E

14 〜 0xe3809C

15 ― 0xE28095

16 \ 0x5C

17 / 0x2Fフルパス指定を行う際のセパレータとしての使用は認める。

18 : 0x3A

19 ; 0x3B

20 , 0x2C

21 * 0x2A

22 ? 0x3F

23 " 0x22

24 < 0x3C

25 > 0x3E

26 . 0x2E"."のみで構成されたフォルダ・ファイルを禁止する。

全般

フォルダ名ファイル名

検索文字列

指針

基本方針に加えて下記をチェックする・半角カナは許容しない・下表「データ保管BOX使用禁止文字」項番1～26に記載されているものは許容しない。・windowの予約語は許容しない。(チェックする予約語は表5 window予約語を参照)　また、予約語+半角スペース×N+ドット+任意の文字列をエラーとする。(N>=0)・改行は削除する。・その他許容しないニックネームは下記の通り(1)最後尾が半角スペース(2)半角スペースのみ(3)最後尾がドット(4)ドットのみ・許容外文字については、変換せず、エラーとする。

基本方針に加えて下記をチェックする・半角カナは許容しない・半角スペースは（0x20）のみ許容する。・下表「データ保管BOX使用禁止文字」項番1～26に記載されているものは許容しない。・改行は削除する。・その他許容しないフォルダ/ファイル名は下記の通り(1)最後尾が半角スペース(2)半角スペースのみ(3)最後尾がドット(4)ドットのみ・許容外文字については、変換せず、エラーとする。

基本方針に加えて下記をチェックする・半角カナは許容しない・半角スペースは（0x20）のみ許容する。・下表「データ保管BOX使用禁止文字」項番1～26に記載されているものは許容しない。・改行は削除する。・許容外文字については、変換せず、エラーとする。

基本方針改行コードあり

使用可能な改行コードは、CR、LF、CRLFとする。

下記入力時にはクライアント側でエスケープ処理を行うこと。・引用符(quotation mark)・バックスラッシュ(reverse solidus)・U+0000～U+001Fの制御文字(control characters(U+0000 through U+001F))

チェックしない



表5　windowsの予約語

項番 windows予約語

1 CON

2 PRN

3 AUX

4 NUL

5 COM1

6 COM2

7 COM3

8 COM4

9 COM5

10 COM6

11 COM7

12 COM8

13 COM9

14 LPT0

15 LPT1

16 LPT2

17 LPT3

18 LPT4

19 LPT5

20 LPT6

21 LPT7

22 LPT8

23 LPT9

　3.データ保管BOXにおける文字コードチェック指針(1バイトの文字コード)

1バイト文字が入力される項目の扱いについて以下の通りとする。

・サーバ側の文字コードのチェック指針：「表6 データ保管BOX　1バイト文字コードチェック指針」参照

・サーバ側の使用可能文字：「表7 パスワード使用可能文字」参照

表6 データ保管BOX　1バイト文字コードチェック指針

項番対象 Portal

1 メールアドレスポータルでメールアドレスの入力場面がないため、チェックなし

2 パスワード・半角文字が4文字以上、16文字以下半角英数字をチェック

表7 パスワード使用可能文字

項番文字文字コード(UTF-8)

1 ` 0x60

2 ~ 0x7E

3 ! 0x21

4 @ 0x40

5 # 0x23

6 $ 0x24

7 % 0x25

8 ^ 0x5E

9 & 0x26

10 * 0x2A

11 ( 0x28

12 ) 0x29

13 _ 0x5F

14 - 0x2D

15 + 0x2B

16 = 0x3D

17 { 0x7B

18 } 0x7D

19 [ 0x5B

20 ] 0x5D

21 \ 0x5C

22 | 0x7C

23 : 0x3A

24 ; 0x3B

25 " 0x22

26 ' 0x27

27 < 0x3C

28 > 0x3E

29 , 0x2C

30 . 0x2E

31 ? 0x3F

32 / 0x2F

サーバ

・半角英数字もしくは半角記号であること・＠が１つ以上含まれていることの2点のみをチェックする・上記を満たさない場合はエラーとする・半角スペースが含まれている場合はエラーとする

・半角文字が4文字以上、16文字以下（数字：0～9　英字：A～Z、a～ｚ、記号）・同文字が3文字以上連続する場合はエラーとする。・記号で許容するものは表7 パスワード使用可能記号の通り



　留意事項

・リクエスト情報についてはURLEncodeを実施すること。



ユーザエージェントについて

連携アプリのユーザエージェント設定について情報要素種別情報長ｵｸﾃｯﾄ最大オクテット表記備考

アプリ種別-提供会社 M F 12 12US-ASCIIで表示できる文字列

形式：[AP識別（3桁）][端末区分（1桁）]-[名称(7桁)]

AP識別：3RD（固定）クライアント区分：0:Android / 1:PC、サーバ

例)3RD0-XXXXXXX"(",")",";"," "は区切り文字のため使用禁止文字とする。

区切り M F 1 1 "/"（固定文字）

ﾌｫｰﾏｯﾄﾒｼﾞｬｰﾊﾞｰｼﾞｮﾝ M F 1 1 初期値は1"1"固定

区切り M F 1 1 "."（固定文字）ﾌｫｰﾏｯﾄﾏｲﾅｰﾊﾞｰｼﾞｮﾝ M F 1 1 初期値は0 "0"固定

区切り M F 1 1<SP>半角スペース（固定文字）

一意識別子 M V 16～36 36US-ASCIIで表示できる文字列

形式不問。ただし、異なる機器にインストールした場合は、　・同一ユーザかつ　・機器かつ　・アプリで重複しないものとして、インストール時に確定したものを設定（詳細は※１　一意識別子の付与単位を参照）。例）　・Android/MacOSの場合　UUID　・Windowsの場合　GUIDが一般的です。

区切り M F 1 1<SP>半角スペース（固定文字）

機種名 M V １～11 11US-ASCIIで表示できる文字列（最大11オクテット）

(文字数オーバの場合は頭11ケタ以外は切り捨て)設定できない場合は、表記に示された文字列で任意の値を設定例)・Androidの場合、"メーカ略号ハイフン通番年度記号"（android.os.Build.MODEL）・Windowsの場合、システムモデル名（PC-VS300HG）"(",")",";"," "は区切り文字のため使用禁止文字とする。

区切り M F 1 1 "("（固定文字）ｱﾌﾟﾘｹｰｼｮﾝ通信種別 M F 5 5 T-APL 全部大文字区切り M F 1 1 ";"（固定文字）

ｱﾌﾟﾘｹｰｼｮﾝﾊﾞｰｼﾞｮﾝ M V １～11 11 数字とピリオドアプリケーションバージョン番号設定できない場合は、表記に示された文字列で任意の値を設定

区切り M F 1 1 ";"（固定文字）

OS名 M V 1～32 32US-ASCIIで表示できる文字列（最大32オクテット）

情報を設定できない場合は、表記に示された文字列で任意の値を設定例）AndroidBlackBerryWindowsMobileWindows7　Professional"(",")",";"は区切り文字のため使用禁止文字とする。

区切り M F 1 1 ";"（固定文字）

OSﾊﾞｰｼﾞｮﾝ M V 1～47 47US-ASCIIで表示できる文字列（最大47オクテット）

情報を設定できない場合は、表記に示された文字列で任意の値を設定例)Service　Pack3"(",")",";"," "は区切り文字のため使用禁止文字とする。

区切り M F 1 1 ")"（固定文字）【種別】　　M：Mandatory（必須）O：Option（付属） 165【 F/ V 】　　V：Variable（可変）　F：Fix（固定）

【例】User-Agent:<SP>3RD0-XXXXBOX/1.0<SP>8e941d80-bf96-11cd-b579-08002b30bfeb<SP>SH-12C(T-APL;01.023.0100;Windows7 Professional;Service Pack3)<CR><LF>

※１　一意識別子の付与単位

ユーザA

ユーザB

機器A

アプリA

アプリB

機器B

アプリC

アプリA

機器C

アプリA

アプリB

機器D

アプリC

アプリD

1

2

アプリB 3

5

1

2

3

4

一意識別子

機器内の同一アプリで、異なる識別を設定する（アプリB）

機器間、かつ同一アプリで異なる識別子を設定する（アプリA）

4

ユーザが異なれば、ユーザ間で一意識別子は重複してよい

オレンジで囲った中で一意識別子は重複しないこと

ユーザエージェント - 31

・時間をおいて再実施・スキャンNGファイルを削除して再実施○

8 - 406

許可されない操作を行った。

クラウドOFF時に許可されていないアクセスを行った。

×

9 - 409

状態コードエラー以下のいずれかの条件を満たす場合・対象のフォルダ・ファイルが操作可能な状態でない場合・操作対象にスキャンNGファイルが含まれている場合

×6 - 404

対象とするファイル、フォルダが見つからない（存在なし）

対象のファイル（フォルダ）のメタ情報が物理的に存在しない場合

×

指定されたIDで取得したメタ情報として返却

×

入力内容を確認、修正をして再実施

5 - 403

認証エラー検証サーバの認証情報チェックでエラーとなった場合当該アカウントが存在しない場合OAuth2.0に関連するエラー（連携アプリ)※APIの呼び出しに必要なスコープが認可されていない場合。

7 - 405

名前変更による該当情報なし（ファイル名）

対象のファイル（フォルダ）のメタ情報のファイル名称が変更されている場合対応外のHTTPメソッドを利用してアクセスされた場合

4 - 401

認可エラー OAuth2.0に関連するエラー※リクエストされたアクセストークンが無効な場合。または、リクエストされたアクセストークンが有効期限切れの場合。

×


3 - 400

パラメータエラーリクエストのパラメータに範囲外の値が設定されていた場合（OAuth1.0に関連するパラメータエラーも含む）OAuth2.0に関連するエラー（連携アプリ)※アクセストークンが設定されていない場合

×


-

×

更新アップロード時に別ファイルとして扱われる場合、レスポンスコードを分ける

2 - 201

新規リソースアップロードに際してファイルID、ファイル名などのメタ情報が変更された

1 - 200

正常正常に処理が終了した場合OAuth2.0の場合のエラー（連携アプリ)※API運用基盤側の内部エラー

No エラーコード HTTPステータスコード概要説明


リトライ可否備考

作成者作成日更新者更新日データ保管BOXサーバデータ保管BOX

システム名機能部名






対象インタフェースにおいて公開停止となっている過去バージョンを指定して呼び出しされた場合

○

時間をおいて再実施

20 - 500

内部エラー内部エラーが発生した場合

×

17 - 423

重複エラー対象のフォルダ・ファイルが既に存在している場合

×16 - 417

リビジョン・ファイルID・フォルダIDの採番範囲値越えを含む

21 - 501

バージョン指定エラー

×

×


取得結果がn件を超えた場合（nはリクエスト情報の検索結果上限数または表示件数）

14 - 415

著作権チェックNG 著作権チェックNGとなったファイルを再度アップロードしようとした場合

リビジョン整合性エラー

リビジョンが変化していた場合

13 - 414

パス長超過エラー対象とするフォルダ・ファイルのフルパス長が最大長を超えた場合

×

ストレージ容量を確保してから実施

12 - 413

ストレージ容量超過エラー

ストレージ容量を超過してしまう場合リクエスト・エンティティが大きすぎる場合

×

×

指定されたIDで取得したメタ情報として返却id一致、path不一致のパターン

×

指定されたIDで取得したメタ情報として返却

×


×

×

19 - 453

名前変更による該当情報なし（パス名）

対象のファイル（フォルダ）のメタ情報のフォルダ名称が変更されている

対象とするファイル、フォルダが移動している

対象とするフォルダ/ファイルのパスが変更されている場合

11 - 411

アップロードサイズ超過エラー

アップロード対象ファイルのファイルサイズが上限値を超えた場合

10 - 410

15 - 416

取得結果上限エラー

18 - 452

対象とするファイル、フォルダが見つからない（有効なし）

対象のファイル（フォルダ）の有効なメタ情報が存在しない場合






×

メタ情報の数をカウントする際は、削除状態のフォルダ・ファイルのメタ情報及びユーザからは参照されない管理用フォルダのメタ情報を含む。

27 - 598

×

接続し直して再実施

28 - -

セッション断圏外などに移動してセッションが強制的に切れてしまった場合(実際にはつながらないので、エラーも返せないはず)

メタ情報上限数超過エラー

サービスが規定しているメタ情報の上限数を超過した場合

26 - 597

メタ情報物理削除期間経過エラー

前回からのメタ情報取得から一定期間（メタ情報が物理削除される期間）を経過している場合

×

メタ情報一括取得を行い、クライアントの情報を最新状態に更新する。

×

フォルダ配下のファイル削除して再実施

25 - 594

フォルダ配下のフォルダ・ファイル数上限到達

アップロード、フォルダ作成、フォルダ・ファイル複製に伴い、指定フォルダ配下でお預かり済みとなっているメタ情報が上限（外部定義）に到達した場合

○

時間をおいて再実施アカウント一時利用停止は、運用者により利用可能状態にしてから実施する。

22 - 503

一時的エラー(利用制限超過)

利用制限を超えるアクセスが発生した場合当該アカウントが一時利用停止の場合リリースなどによる計画的なサーバ停止の場合

24 - 584

共有エラー② 対象フォルダ/ファイルが共有の大元フォルダ/ファイルであるために操作可能な状態でない場合

×

対象のファイル/フォルダの共有を解除をして再実施。

23 - 583

共有エラー① 対象フォルダが共有の上位フォルダであるために操作可能な状態でない場合

×

対象のフォルダ配下のすべての共有を解除をして再実施。

*1 API運用基盤の内部処理エラー

*2 HTTPステータスコードの返却優先度については、別紙「HTTPステータスコードの返却優先度」を参照。

○

○

○

○

○

○

○

○

○

- - ○ -○ - -○ ○ ○ ○ ○ ○

○ - - - - - - - - - - - ○ ○

- - - ○ ○ - - ○ -○ - - - - -○ ○ - - - ○○ ○ ○ ○ ○ ○○ - ○11 IF_XLB_R212 4 ファイル、フォルダ複製 ○ ○

- - - ○ -- ○ - ○○ ○ - - - -○ ○ ○ - - -- - - ○○ - - - ○ -○ ○ - - ○○ - - - ○ ○

- - - -

10 IF_XLB_R211 4 フォルダ作成 ○

○ - - -- - - - - -○ - - - - ○- - - -

○ -

- - - - - ○○ ○ - - ○ -- - - ○ ○9 IF_XLB_R210 4 検索 ○ ○ ○ ○

- - ○ -- - ○ -○ - - - - -○ ○ - - - ○○ ○ ○ ○○ - ○ ○ - -○ ○ ○ ○ ○ ○- - - ○ ○7 IF_XLB_R208 4 ファイル/フォルダ移動(名前変更) ○ ○

- - - - -- ○ - -○ ○ - - - -○ ○ ○ - - -- ○

○ ○

○ ○○ ○ - - - -○ ○ ○ ○ ○○ - - - ○ ○

- - - -

6 IF_XLB_R207 4 ファイル、フォルダ削除 ○

- - - -○ - - - - -○ ○ - - - ○○ - ○ -

- ○

○ - - - - -○ ○ ○ ○ ○ ○- - - ○ ○5 IF_XLB_R206 4 ダウンロード ○ ○

- - - ○ -- ○ - ○○ ○ - - - -○ ○ ○ - - -- -

○ ○

- ○○ - - ○ ○ -○ ○ - - ○○ ○ - - ○ ○

- - ○ -

4 IF_XLB_R205 4 アップロード ○

○ - ○ -○ - - - - -○ ○ - - - ○- - - -

○ -

- ○ ○ - ○ -○ ○ - - ○ ○- - - ○ ○3 IF_XLB_R204 4 アップロード事前投入 ○ ○

- - ○ - -- - - -○ ○ - - - -○ ○ ○ - - -○ ○

○ ○

- ○ ○ ○- ○ - - - -○ ○ ○ ○ ○○ - - - ○ ○ ○

- - - ○ ○ - - - -

2 IF_XLB_R203 4 ファイル/フォルダ差分情報取得 ○

- - - -○ - - - - -○ ○ - - - ○-

454 516 584404

*2

405

*2406

409

*2

410

*2411302 306 400 401 403

○ - - - - -○ ○ ○ ○ ○ - - ○ ○

597586 587 588 589 590 591

石田　雄一郎作成者

No インターフェースIDインターフェース

バージョンインターフェース名称

HTTPステータスコード

1 IF_XLB_R202 4 ファイル/フォルダ情報取得(メタ情報取得) ○ ○ ○ ○

520 530 531 540 544 585452

*2

453

*2500 501 備考200

200

*1201 299

更新者更新日データ保管BOXサーバデータ保管BOX 2012/11/29 石田　雄一郎 2012/12/5

エラーマッピングシステム名機能部名作成日

503 515413 414 415 416417

*2423 593583 598 599594 595 596

12 IF_XLB_R213 4 データ全削除 ○ - - - - ○ ○ - ○ - - - ○ - - - - - - - - - - - - - - - - - - ○-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

○

-

-

-

-

-

-

-

-

-

-

○

-

-

-

-


HTTPステータスで返却するエラーコードには以下の分類が存在する。項番チェック分類概要

1 認証

2 共有チェック3 権限チェック4 上限数チェック5 業務チェック

各IF実行時に返却されるHTTPステータスのうち、共有にかかわるエラーコードの優先度について以下に示す。優先度エラーコードエラーコード概要エラーコードが返却される状態の説明

1 540 未共有設定エラー共有設定が物理的に存在しない、もしくは有効でない場合

2 544 共有情報無しエラー共有設定は実施されているが、共有対象のフォルダ・ファイル情報が物理的に存在しない、もしくは有効でない場合

3 590 共有状態エラー対象の共有フォルダ・ファイルが操作可能な状態でない場合

各IF実行時に返却されるHTTPステータスのうち、フォルダ・ファイル情報にかかわるエラーコードの優先度について以下に示す。

パス文字列 /aaa/bbb/ccc

優先度エラーコードエラーコード概要エラーコードが返却される状態の説明1 598 メタ情報上限数超過エラーメタ情報が上限（外部定義）に到達した場合

2 594フォルダ配下のフォルダ・ファイル数上限到達

指定フォルダ配下でお預かり済みとなっているメタ情報が上限（外部定義）に到達した場合

3 404対象とするファイル、フォルダが見つからない（存在な

メタ情報が物理的に存在していない場合

4 452対象とするファイル、フォルダが見つからない（有効なし）

ＩＤとパスでメタ情報を検索した結果、IDが異なる場合。または、対象の削除状態フラグが0以外の場合、ただしメタ情報一括取得、メタ情報差分取得で属性コードが無指定の場合

5 410対象とするファイル、フォルダが移動している

ＩＤとパスでメタ情報を検索した結果、上記パス文字列の/aaa/bbb/の部分が異なる場合

6 453名前変更による該当情報なし（パス名）

ＩＤとパスでメタ情報を検索した結果、上記パス文字列のcccの部分が異なる　かつ　cccがフォルダの名前である場合

7 405名前変更による該当情報なし（ファイル名）

ＩＤとパスでメタ情報を検索した結果、上記パス文字列のcccの部分が異なる　かつ　cccがファイルの名前である場合

8 417 リビジョン整合性エラーリビジョンが変化していた場合

※上記以外は処理の順序に合わせて返却される

各IF実行時に返却されるHTTPステータスのうち、認可済みCookie/Tokenチェック、同期設定状態チェックに関するエラーコードの優先度について以下に示す。優先度エラーコードエラーコード概要エラーコードが返却される状態の説明

1 403 認可エラー認証情報チェックでエラーとなった場合2 406 許可されない操作を行ったクラウドOFF時に許可されていないアクセスを行った

各業務内で実施しているチェックを実施する。

該当ユーザがアクセス可能なユーザかをチェックする。

共有領域に対してアクセス可能な状態にあるかをチェックする。連携アプリ領域に対してアクセス可能な状態にあるかをチェックする。操作対象が上限数を上回った件数となっていないかをチェックする。

データ保管box api技術資料 - amazon web services...data_storage_box_api_spec_v1.10.xlsx...

Documents