マイポケット api リファレンス...copyright © 2016 ntt communications 5 sort5 string...

Copyright © 2016 NTT Communications

i

マイポケット API リファレンス

第 1.3版

2016年 3月 30日

NTT コミュニケーションズ株式会社


ii

改版履歴

日付版変更内容

2014/7/10 1.0 初版

2014/12/1 1.1

・ID呼称変更に基づく文言変更 MycocoaID⇒ログイン ID ・以下の APIの記載を変更タグ一覧取得 API 人物一覧取得 API ファイル取得 API ファイル・フォルダ一覧検索 API

・以下の APIを追加ファイル移動 API フォルダ変更 API フォルダ移動 API タグ変更 API タグ削除 API ZIP作成 API ZIP進捗結果 API 人物登録 API 人物変更 API 人物削除 API 人物グループ一覧取得 API 人物グループ追加 API 人物グループ取得 API 人物グループ変更 API 人物グループ削除 API

・その他文言修正

2015/5/14 1.2 以下の APIの記載を変更ファイル・フォルダ一覧検索 API

2016/3/30 1.3

以下の APIの記載を変更ファイル取得 API ファイル・フォルダー一覧検索 API タグ一覧取得 API タグ変更 API


iii

目次

1. 認証 ............................................................................................................................................................................................. 4

1.1. WSSE 認証 .......................................................................................................................................... 4

1.2. トークン認証 ....................................................................................................................................... 4

1.2.1. マイポケット認証シーケンス ...................................................................................................... 5

2. リクエストについて ................................................................................................................................................................. 5

2.1. Content-Type ...................................................................................................................................... 5

2.2. Content-Length ................................................................................................................................... 5

3. レスポンスについて ............................................................................................................................................................... 6

3.1. 正常時 ................................................................................................................................................ 6

3.2. 異常時 ................................................................................................................................................ 7

3.3. その他 ................................................................................................................................................ 8

4. マイポケットについて ............................................................................................................................................................ 9

4.1.1. ユーザ領域 ................................................................................................................................. 9

4.2. 各領域で可能な操作 ....................................................................................................................... 10

5. マイポケット API ................................................................................................................................................................... 11

5.1. トークン払い出し API ..................................................................................................................... 11

5.2. ファイル登録 API ........................................................................................................................... 13

5.3. ファイル取得 API ........................................................................................................................... 17

5.4. ファイルコピーAPI .......................................................................................................................... 25

5.5. ファイル移動 API ........................................................................................................................... 27

5.6. ファイル・フォルダ一覧検索 API ................................................................................................... 29

5.7. フォルダ作成 API ........................................................................................................................... 64

5.8. フォルダ取得 API ........................................................................................................................... 67

5.9. フォルダ変更 API ........................................................................................................................... 69

5.10. フォルダ移動 API ........................................................................................................................... 72

5.11. タグ登録 API .................................................................................................................................. 74

5.12. タグ一覧取得 API .......................................................................................................................... 76

5.13. タグ変更 API .................................................................................................................................. 79

5.14. タグ削除 API .................................................................................................................................. 83

5.15. シーン分類一覧取得 API .............................................................................................................. 83

5.16. ファイルタイプ一覧取得 API .......................................................................................................... 86

5.17. ZIP 作成 API ................................................................................................................................... 88

5.18. ZIP 進捗結果 API ........................................................................................................................... 90

5.19. 人物一覧取得 API ......................................................................................................................... 92

5.20. 人物登録 API ................................................................................................................................. 95

5.21. 人物取得 API ................................................................................................................................. 98

5.22. 人物変更 API ............................................................................................................................... 100

5.23. 人物削除 API ............................................................................................................................... 104

5.24. 人物グループ一覧取得 API ........................................................................................................ 105

5.25. 人物グループ追加 API ................................................................................................................ 108

5.26. 人物グループ取得 API ................................................................................................................... 110

5.27. 人物グループ変更 API ................................................................................................................ 112

5.28. 人物グループ削除 API ................................................................................................................ 114


4

1. 認証

マイポケット APIは、WSSE認証とトークン認証を利用します。

WSSE認証は、トークン払い出し APIのみで利用し、トークン認証は、その他の各 APIで利用します。

1.1. WSSE 認証

WSSE認証を利用する場合は、以下をリクエストヘッダに指定します。

X-WSSE: UsernameToken Username="①", PasswordText="②", AccessKey="③",

UsernameType="④"

※1 「OCN会員登録証」または「お申込内容のご案内」に記載の 10桁のお客さま番号またはログイン ID

1.2. トークン認証トークン認証を利用する場合は、以下をリクエストヘッダに指定します。

Authorization: Bearer ①

X-Authorization: AccessKey="②"

No 説明

① マイポケットのログイン ID ※1

② ①のログイン IDに対応するパスワード

③ Developer Consoleでアプリケーション登録時に発行されたアクセスキー

④

①のログイン ID種別

0：お客さま番号

1：ログイン ID（お客さまが自由に設定することのできる ID）

No 説明

① トークン払い出し API より発行したアクセストークン

② Developer Consoleのアプリケーション登録時に発行したアクセスキー


5

1.2.1. マイポケット認証シーケンスマイポケット APIの利用は以下のシーケンスで行います。

(1) トークン払い出し API（WSSE 認証）リクエスト

アプリは、トークン払い出し API （WSSE認証）を呼び出します。

リクエスト時に、マイポケットのログイン ID、ログイン ID に対応するパスワード、アクセスキーを指定します。

(2) トークン払い出し API レスポンス

マイポケットは、トークン払い出し APIのレスポンスで、有効期限付きのアクセストークンを払い出します。

(3) 各 API（トークン認証）リクエスト

アプリは、必要に応じて各 API（トークン認証）を呼び出します。

リクエスト時に、アクセストークン、アクセスキーを指定します。

(4) 各 API レスポンス

マイポケットは、各 APIのレスポンスを返却します。

（3）で指定したアクセストークンが有効期限切れの場合、認証エラーを返却します。

その場合は、再度（1）トークン払い出し APIを呼び出し、新しいアクセストークンを払い出してください。

2. リクエストについて

2.1. Content-Type リクエストヘッダに Content-Typeを付与し、各 APIに対応する値を指定してください。指定値は各 API のリ

クエストヘッダを参照してください。

2.2. Content-Length リクエストボディがある場合、リクエストヘッダに Content-Length を付与し、リクエストボディの長さ(byte)を

指定してください。

アプリマイポケット

（1）トークン払い出し API（WSSE 認証）リクエスト

（2）トークン払い出し APIレスポンス

（3）各 API（トークン認証）リクエスト

（4）各 API レスポンス


6

3. レスポンスについて

3.1. 正常時正常時は以下のレスポンスコードを返します。

レスポンスパラメータで array形式の情報を返却する場合、array形式の情報の件数が 1件の場合、2件以

上の場合についてそれぞれ以下の形式でボディを返す。

Array 形式 [files] の情報の件数が 1 件の場合

array 形式 [files] の情報の件数が 2 件以上の場合

No レスポンスコード説明

1 200 OK GET メソッドでデータ取得に成功したときなど

202 Accepted、204 No Content も 200 OK で返却します。

2 201 Created POST メソッドで新規リソースの作成に成功したときなど

{

files :

{

"XXX" : "111",

"YYY" : "11111"

}

}

{

files :

[

{

"XXX" : "111",

"YYY" : "11111"

},

{

"XXX" : "222",

"YYY" : "22222"

}

]

}


7

3.2. 異常時異常時は以下のレスポンスコードを返します。

400 Bad Request（エラー1件）のレスポンスサンプル

400 Bad Request（エラー複数件）のレスポンスサンプル

No 説明

① エラーコード

② エラーメッセージ


1 400 Bad Request

リクエストパラメータ誤りや既に存在するリソースに POST したなど、リク

エストが間違っています。

403 Forbidden、405 Method Not Allowed、409 Conflict も 400 Bad

Request として返却します。

2 404 Not Found リクエスト先のリソースが存在しません。

3 500 Internal Server Error サーバーで予期せぬエラーが発生しました。

4 503 Service Unavailable サーバーは一時的な過負荷やメンテナンスでレスポンスが返却できませ

ん。

HTTP/1.1 400 Bad Request

Content-Type: application/json

{

errors :

{

"code":"①",

"message":"②"

}

}

HTTP/1.1 400 Bad Request


{

errors : [

{"code":"①", "message":"②"},

{"code":"①", "message":"②"}

]

}


8

3.3. その他正常時、異常時以外の場合は、以下のレスポンスコードを返します。


1 301 Moved Permanently GET メソッドで取得対象となるリソースが恒久的に移動しています。

2 302 Found 301 と同様ですが、こちらは一時的に移動しています。


9

4. マイポケットについて

4.1.1. ユーザ領域マイポケットでのユーザ領域は、ユーザルートフォルダ内に、ファイル領域、フォト領域、ムービー領域があ

り、以下の構造となっております。

ユーザルートフォルダ

├ ファイル領域ルート（ファイル）

│├ ストックフォルダ

│├ 特殊フォルダ

│├ 通常フォルダ

││└ 通常フォルダ

│└ 通常フォルダ

│ ：

├ フォト領域ルート（フォト）

│├ ストックアルバム

│├ フォトアルバム

│ ：

│└ その他アルバム

│

└ ムービー領域ルート（ケータイムービー）

├ ストックムービーアルバム

├ ムービーアルバム

│ ：

└ その他アルバム

# 領域フォルダ説明

1

ファイル領域ストックフォルダデフォルトのフォルダ

通常フォルダフォルダ作成 APIで作成できるフォルダ

特殊フォルダ

特定のアプリケーションによって作成されるフォルダ

フォルダによって一部できない操作があり、エラーとなるものがありま

す。

2

フォト領域ストックアルバムデフォルトのフォルダ

フォトアルバムフォルダ作成 APIで作成できるアルバム

その他アルバムデフォルトのフォルダ

ファイル領域内のフォト拡張子ファイルを表示します。

3

ムービー領域ストックムービー

アルバムデフォルトのフォルダ

ムービーアルバムフォルダ作成 APIで作成できるアルバム

その他アルバムデフォルトのフォルダ

ファイル領域内のムービー拡張子ファイルを表示します。

ファイル領域

フォト領域

ムービー領域


10

4.2. 各領域で可能な操作

# 領域フォルダ作成フォルダ内の

フォルダ作成

ファイル

フォルダ内で扱える

拡張子

アップ

ロード

ダウン

ロード

1 ファイル領域

ストックフォルダ × × 全ての拡張子

◯ ◯

通常フォルダ ◯ ◯ ◯ ◯

特殊フォルダ × △ フォルダによって制限

あり △ △

2 フォト領域

ストックアルバム × ×

フォト拡張子のみ

jpg,jpeg,jpe,jfif ◯ ◯

フォトアルバム ◯ × ◯ ◯

その他アルバム × × × ◯

3 ムービー領域

ストックムービー

アルバム × ×

ムービー拡張子のみ

avi

wmv, asf, avi

mp4, m4v, mpg4

3gp, 3g2

mov, moov, qt

mpg, mpeg, m2p, m2v

ts, m2t, m2ts

flv, f4v, f4p, f4a, f4b

◯ ◯

ムービーアルバム ◯ × ◯ ◯

その他アルバム × × × ◯


11

5. マイポケット API

5.1. トークン払い出し API

マイポケットの各 API を利用するためのトークン（アクセストークン）を発行します。

発行したトークン（アクセストークン）を利用して、マイポケットの各 APIをご利用ください。

リクエスト URI

HTTP メソッド：GET 文字コード：UTF-8

https://cocoa.ntt.com/rest/users/v1/token?mode={mode}

No キー型必須説明サンプル値

1 mode string ◯ 取得するトークンのモード

0：固定 0

リクエストヘッダ


1 X-WSSE string ◯ 「1.1 WSSE 認証」参照－

2 Content-Type string ◯ 「application/json」を指定－

レスポンスヘッダ


1 Content-Type string ◯ コンテンツタイプ application/json

レスポンスボディ


1 1 token string ◯ アクセストークン

86byte、半角英数字、記号(-.)

2 issued string ◯ アクセストークン発行日時

yyyy-MM-dd'T'HH:mm:ss+09:00 (※1) 2005-06-28T01:57:

52+09:00

※1 [ISO-8601]に準拠した日付の形式

https://cocoa.ntt.com/rest/users/v1/token?mode=%7bmode%7d


12

リクエストサンプル

レスポンスサンプル

GET https://cocoa.ntt.com/rest/users/v1/token?mode=0

X-WSSE: UsernameToken Username="1234567890", PasswordText="password",

AccessKey="accesskey”, UsernameType="0”


HTTP/1.1 200 OK


{

"token": "accesstoken",

"issued": "2005-06-28T01:57:52+09:00"

}


13

5.2. ファイル登録 API

登録するフォルダ ID（ファイル・フォルダ一覧検索 API で取得可能）とファイル、ファイルの属性情報を指定

して、ファイルを登録します。

登録するファイルがフォト拡張子の場合、登録時に縮小画像（短辺150px）、縮小画像（長辺250px）を作成

します。

リクエスト URI

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

https://cocoa.ntt.com/rest/storage/v1/files/{folderId}/upload


1 folderId string ◯

登録するフォルダ ID

ファイル・フォルダ一覧検索 API で取得した

フォルダ ID を指定

1~20byte、半角数字

12345670



1 Authorization string ◯ 「1.2 トークン認証」参照 -

2 X-Authorization string ◯ 「1.2 トークン認証」参照 -

3 Content-Type string ◯ 「application/octet-stream」を指定 -

4 Content-length string ◯ リクエストボディの長さ(byte)を指定 102400

5 Slug string ○

登録するファイル名 (拡張子含む)

URL エンコードして指定

URL エンコード前で 1~256byte、全半角文字(半

角カタカナを除く)

%e3%82%b5%e3%

83%b3%e3%83%97

%e3%83%ab%2ejp

g

(URL エンコード前：

サンプル.jpg)

6 X-Comment string

登録するファイルのコメント


URLエンコード前で0~500文字、全半角文字(半

角カタカナを除く)

%e3%82%b3%e3%

83%a1%e3%83%b3

%e3%83%88


コメント)

https://cocoa.ntt.com/rest/storage/v1/files/%7bfolderId%7d/upload


14

7 X-ShotDate string

登録するファイルの撮影日時

yyyy-MM-dd'T'HH:mm:ss+09:00 形式 (※1)

ファイル領域へフォト拡張子ファイル、ムービー

拡張子ファイルを、フォト領域へフォト拡張子フ

ァイルアップロートの場合指定可能

キー未指定時、ファイルの Exif 情報を登録

2005-06-28T01:57:

57+09:00

8 X-Latitude string

登録するファイルの撮影場所/更新場所の緯度

半角数字(小数点第 13 位まで)

符号(-),小数点(.)


45.1234567890123

9 X-Longitude string

登録するファイルの撮影場所/更新場所の経度


符号(-),小数点(.)


120.123456789012

3


リクエストボディ


1 バイナリデータ string ◯ バイナリデータ






1 fileId string ◯ 登録したファイル ID

1~20byte、半角数字 123456780

2 title string ◯ 登録したファイル名 (※1)

1~256byte、全半角文字(半角カタカナを除く) サンプル.jpg


15

3 issued string ◯ 登録したファイルの作成日時

yyyy-MM-dd’T’HH:mm:ss+09:00 形式 (※2)

2014-01-01T01:57:

57+09:00

4 summary string ◯

登録したファイルのコメント (※1)

0~500 文字、全半角文字(半角カタカナを除

く)

コメント

5 shotDate string ◯ 登録したファイルの撮影日時

yyyy-MM-dd’T’HH:mm:ss+09:00 形式 (※2)

2013-12-01T01:57:

57+09:00

6 latitude string ◯

登録したファイルの撮影場所/更新場所(緯

度)

半角数字(-90~90,整数部 2 桁,小数部 13 桁 0

埋め)、記号(-.)

90.0000000000000

7 longitude string ◯

登録したファイルの撮影場所/更新場所(経

度)

半角数字(-180~180,整数部 3桁,小数部 13桁 0


180.000000000000

0

※1 バックスラッシュエスケープシーケンスを行う



16



POST https://cocoa.ntt.com/rest/storage/v1/files/12345670/upload

Authorization: Bearer accesstoken

X-Authorization: AccessKey=”accesskey”

Content-Type: application/octet-stream

Slug: %e3%82%b5%e3%83%b3%e3%83%97%e3%83%ab%2ejpg (URL エンコード前：サンプル.jpg)

X-Comment: %e3%82%b3%e3%83%a1%e3%83%b3%e3%83%88 (URL エンコード前：コメント)

X-ShotDate:2013-08-09T13:27:30+09:00

X-Latitude:45.1234567890123

X-Longitude:120.0123456789123

(binary data .....)

HTTP/1.1 201 Created

Content-Type:application/json

{

"fileId":"123456780",

"title":"サンプル.jpg",

"issued":"2005-06-28T01:57:30+09:00",

"summary":"コメント",

"shotDate":"2005-06-28T01:57:30+09:00",

"latitude":"05.1234567890123",

"longitude":"120.0123456789123"

}


17

5.3. ファイル取得 API

取得するファイル ID（ファイル・フォルダ一覧検索 API で取得可能）を指定して、ファイルの属性情報、

または縮小画像、またはオリジナルデータを取得します。

Mode=1 (縮小画像(短辺 150px)ダウンロード) で縮小画像のないムービーファイルの取得を行った場合、

縮小画像の作成のみが行われます。縮小画像を取得するためには、再度、取得処理を行ってください。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/files/{fileId}?mode={mode}&expressiveEsti

mationFlg={expressiveEstimationFlg}&reload={reload}


1 fileId string ◯ 取得するファイル ID

1~20byte、半角数字 12345670

2 mode string

取得するファイルのモード

0：属性情報

1：縮小画像(短辺 150px)ダウンロード

2：縮小画像(長辺 800px)ダウンロード

3：オリジナルファイルダウンロード



キー未指定時、空値指定時は「0」

mode=2,4,5 はフォト拡張子ファイルのみ指定

可能

0

3 expressiveEstim

ationFlg string

表情推定情報取得フラグ

on：表情推定情報を取得する

off：表情推定情報を取得しない

On

4 reload string

最新情報取得フラグ

・off：キャッシュを利用、ない場合は最新情報を

取得

・on：最新情報を取得

キー未指定時、空値指定時は「off」

On

https://cocoa.ntt.com/rest/storage/v1/files/%7bfileId%7d?mode=%7bmode%7d&expressiveEstimationFlg=%7bexpressiveEstimationFlg%7d&reload=%7breload%7d

https://cocoa.ntt.com/rest/storage/v1/files/%7bfileId%7d?mode=%7bmode%7d&expressiveEstimationFlg=%7bexpressiveEstimationFlg%7d&reload=%7breload%7d


18



1 Authorization string ◯ 「1.2 トークン認証」参照

2 X-Authorization string ◯ 「1.2 トークン認証」参照

3 Content-Type string ◯ 「application/json」を指定




2 X-Result-code string

縮小画像の状態

サムネイル作成結果

0：未作成

1：作成済（縮小画像をレスポンスボディに指定）

2：作成失敗

3：対象外

キー出力条件

mode=1 指定時のみ

1



1 title string

取得したファイル名 (拡張子含む)

1~256byte、全半角文字(半角カタカナを除く)(※

1)

キー出力条件


サンプルファイ

ル.txt

2 comment string

取得したファイルのコメント

全半角文字(半角カタカナを除く)(※1)

キー出力条件

mode=0 指定時で値がある場合のみ

サンプルコメント

です。

3 issued string

取得したファイルの作成日時

yyyy-MM-dd’T’HH:mm:ss+09:00 形式(※2)

キー出力条件


2013-08-01T00:00:

00+09:00


19

4 shotDate string

取得したファイルの撮影日時


キー出力条件


2012-07-07T19:32:

00+09:00

5 modified string

取得したファイルの更新日時


キー出力条件


2013-08-03T14:05:

00+09:00

6 latitude string

取得したファイルの撮影場所/更新場所(緯度)

半角数字(-90~90,整数部 2 桁,小数部 13桁 0


キー出力条件


35.6603650000000

7 longitude string

取得したファイルの撮影場所/更新場所(経度)

半角数字(-180~180,整数部 3桁,小数部 13桁 0


キー出力条件


139.745394000000

0

8 movieTime string

取得したファイルのムービー時間

HHHHHH:MM:SS形式

HHHHHH：前 0 なし 6桁まで(0～999999)

MM及び SS：前 0 あり 2桁固定(00～59)

キー出力条件


8:59:00

9 tagId array

取得したファイルに紐づくタグ ID（複数可）

半角数字、格納する型：string

キー出力条件


1001,1002

10 updateFlg string

更新可否フラグ

1：更新可

0：更新不可

キー出力条件


0

11 breadcrumbs string

取得したファイルのパンくずリスト

キー出力条件


ファイル/ストッ

クフォルダ


20

12 sceneId array

取得したファイルに紐づくシーン ID（複数可）

1~3byte、半角数字、格納する型：string

キー出力条件


301,302,100,200

13 faceId array

取得したファイルに紐づく人物 ID

6byte、半角数字、格納する型：string

キー出力条件


100000,100020

14 clockwiseRotate

Angle string

正位置までの回転角度（時計回りに何度回転

すると上向きになるかを表した値）

0: 無回転

90: 右 90度回転で正位置



キー出力条件


90

15

expressiveEstima

tionList array

表情推定情報リスト

キー出力条件

mode=0 かつ expressiveEstimationFlg=on指定

時のみ

1 expressiveEsti

mationId string

表情推定情報 ID


キー出力条件


時のみ

1234

2 faceid string

人物 ID

6byte、半角数字

キー出力条件


時のみ

100000,100020

3 faceCoordinat

es string

顔位置情報

半角数字およびマイナス記号「-」

顔位置の各 XY 座標を指定

左上 X_左上 Y_右上 X_右上 Y_左下 X_左下

Y_右下 X_右下 Yの順に「_」区切りで記述キ

ー出力条件


時のみ

10_10_10_10_10_

10_10_10

4 age string

年齢


キー出力条件


時のみ

28


21

5 gender string

性別

1byte、半角数字

1: 男

2: 女

キー出力条件


時のみ

1

6 expression string

表情種別フラグと表情タイプごとのパーセント

値「%値(無表情)」「%値(喜)」「%値(驚)」「%値

(怒)」「%値(悲)」「%値(恐)」「%値(嫌)」を区切り

文字「_」で結合した文字列

%値は 0～100 の整数値

表情種別フラグは表情タイプを組み合わせた

半角数字 2byte

【表情種別フラグ】

01(無) 12(無喜) 13(無驚) 14(無怒) 15(無悲)

16(無恐) 17(無嫌)

02(喜) 23(喜驚) 24(喜怒) 25(喜悲) 26(喜恐)

27(喜嫌)

03(驚) 34(驚怒) 35(驚悲) 36(驚恐) 37(驚嫌)

04(怒) 45(怒悲) 46(怒恐) 47(怒嫌)

05(悲) 56(悲恐) 57(悲嫌)

06(恐) 67(恐嫌)

07(嫌)

09(レコメンドなし)

【表情タイプ】

1：無表情

2：喜

3：驚

4：怒

5：悲

6：恐

7：嫌

9：レコメンドなし

0：対象の表情単独であることを示すフラグ

キー出力条件


時のみ

2_10_70_20_35_2

0_40_60

7 eyes string

視線種別と上下視線と左右視線の実値を区切

り文字「_」で結合した文字列

実値は -90～90 の整数値

2_-20_70


22

【視線種別】

1：正面

2：その他

キー出力条件


時のみ

8 closeEyes string

目つむり種別と左目つむりと右目つむりの実値

を区切り文字「_」で結合した文字列

実値は 0～1000の整数値のみ

【目つむり種別】

1：目ひらき

2：目つむり

3：ウィンク

4：レコメンドなし

キー出力条件


時のみ

1_700_150

9 smile string

笑顔度

キー出力条件


時のみ

50

10 baby string

赤ちゃん度

キー出力条件


時のみ

50

16 annoTagId array

取得したファイルに紐づくアノテーションタグ ID

（複数可）


キー出力条件

mode=0 かつアノテーションタグ ID が設定され

ている時のみ

1001,1002

17 １

６ binary string

バイナリ

mode の値に対応するバイナリデータ

キー出力条件

mode=0 指定時以外のみ

※1 バックスラッシュエスケープシーケンスを行う。



23



GET https://cocoa.ntt.com/rest/storage/v1/files/12345670?mode=0&expressiveEstimationFlg=on&

reload=on




HTTP/1.1 200 OK

mode=0 (属性情報) 、expressiveEstimationFlg=on指定時

Content-type : application/json

{

"title": "サンプルファイル.txt",

"comment": "サンプルコメントです。",

"issued":"2013-08-01T00:00:00+09:00"

"modified": "2013-08-03T14:05:00+09:00",

"shotDate": "2012-07-07T19:32:00+09:00",

"latitude": "35.6603650000000",

"longitude": "139.7453940000000",

"tagId": ["1001", "1002"],

"updateFlg": "1",

"breadcrumbs": "ファイル/ストックフォルダ"

"sceneId": ["301", "302", "303", "100"", "200"],

"faceId": ["100000","100020"]

"clockwiseRotateAngle": "0",

"expressiveEstimationList": [

{

"expressiveEstimationId": "1234",

"faceid": "100000",

"faceCoordinates":"10_10_10_10_10_10_10_10",

"age": "28",

"gender": "1",

"expression": "2_10_70_20_35_20_40_60",

"eyes": "2_-20_70",

"closeEyes": "1_700_150",

"smile": "50",

"baby": "50"

},

{

"expressiveEstimationId": "1235",

"faceid": "100020",


24

"faceCoordinates":"15_15_15_15_15_15_15_15",

"age": "22",

"gender": "2",

"expression": "3_10_50_80_35_20_40_60",

"eyes": "2_-20_70",

"closeEyes": "1_700_150",

"smile": "50",

"baby": "50"

}

],

"annoTagId": ["1001", "1002"]

}

mode=1 (縮小画像(短辺 150px)ダウンロード) 指定時で、サムネイル未作成の場合

Content-Type: video/mp4

X-Result-code: 0

mode=1 (縮小画像(短辺 150px)ダウンロード) 指定時で、サムネイル作成済みの場合

Content-Type: image/jpeg

X-Result-code: 1

(binary data .....)

mode=2,3,4,5 の場合

Content-Type: image/jpeg

(binary data .....)


25

5.4. ファイルコピーAPI

コピーするファイル ID とコピー先のフォルダ IDを指定して、ファイルをコピーします。

（ファイル ID、フォルダ ID共にファイル・フォルダ一覧検索 API で取得可能）

コピー先は同じ領域（ファイル領域、フォト領域、ムービー領域）を指定してください。

ただし、フォト拡張子ファイルのみ、ファイル領域からフォト領域、フォト領域からファイル領域へのコピーが

可能です。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/files/copy









1 1 fileId array ◯

コピーするファイル ID

1~20byte、半角数字,

格納する型：string

区切り文字(,)で複数指定可

同一のファイル ID を複数指定した場合、コ

ピーは 1 回のみ

10000107,1000020

7

2 2 targetFolderId string ○ コピー先のフォルダ ID

1~20byte、半角数字 123456789


26






1 copyFileName array ◯

コピーしたファイル名 (拡張子含む) (※1)

1~256byte、全半角文字(半角カタカナを除く)


複数コピーした場合は、配列で返却

同じファイルを複数指定時は 1 件のみ返却

copyFileName1




POST https://cocoa.ntt.com/rest/storage/v1/files/copy




Content-length:68

{

"fileId":["10000107","10000207"],

"targetFolderId":"123456789"

}



{

"copyFileName":["copyFileName1","copyFileName2"]

}


27

5.5. ファイル移動 API

移動するファイル ID と移動先のフォルダ ID を指定して、ファイルを移動します。

（ファイル ID、フォルダ ID共にファイル・フォルダ一覧検索 API で取得可能）

移動先は同じ領域（ファイル領域、フォト領域、ムービー領域）を指定してください。

ただし、フォト拡張子ファイルのみ、ファイル領域からフォト領域、フォト領域からファイル領域への移動が

可能です。

リクエスト URI

HTTP メソッド：PUT 文字コード：UTF-8

https://cocoa.ntt.com/rest/storage/v1/files/move









1 fileId array ◯

移動するファイル ID

1~20byte、半角数字,


区切り文字(,)で複数指定可

同一のファイル IDを複数指定した場合、移動

は 1 回のみ

複数のファイルを移動する場合、同じフォルダ

(アルバム)に格納されているファイルのみ指定

できる

10000107,1000020

7

2 targetFolderId string ○ 移動先のフォルダ ID

1~20byte、半角数字 123456789


28






1 movedFileName array ◯

移動したファイル名 (拡張子含む) (※1)

1~256byte、全半角文字(半角カタカナを除く)


複数移動した場合は、配列で返却

同じファイルを複数指定時は 1 件のみ返却

movedFileName1




POST https://cocoa.ntt.com/rest/storage/v1/files/move




Content-length:63

{

"fileId":["10000107","10000207"],

"targetFolderId":"123456789"

}

HTTP/1.1 200 OK


{

"movedFileName":["movedFileName1","movedFileName2","movedFileName3"]

}


29

5.6. ファイル・フォルダ一覧検索 API

ファイル・フォルダの検索方法をクエリパラメータに指定し、取得対象をオプションパラメータに指定して、

該当するファイル・フォルダ一覧（上位フォルダ ID（※）ファイル・フォルダ ID、ファイル・フォルダ名、ファイル・

フォルダ種別、コメント、作成日時、更新日時、撮影日、撮影場所/更新場所、ムービー時間、アルバム内ファ

イル数（※）、アルバム最終追加ファイル ID（※）、アルバム最終追加ファイル更新日時（※）、上向きへの回

転角度、オリジナルフォトの縦幅(px)、オリジナルフォト横幅(px)、タグ ID、シーン ID、人物 ID、アノテーションタ

グ ID、検索該当件数）を取得します。

※フォルダ ID 検索を指定した場合のみ、上位フォルダ ID、アルバム内ファイル数、アルバム最終追加フ

ァイル ID 、アルバム最終追加ファイル更新日時）を取得します。

検索方法

1. ファイル・フォルダ・アルバム名検索

2. フォルダ ID 検索

3. タグ ID検索

4. 撮影日・作成日検索

5. 撮影期間検索

6. 撮影場所・更新場所検索

7. ファイルタイプ ID 検索

8. シーン ID 検索

9. 人物 ID検索

10. 人物グループ ID検索

11. 表情推定情報検索

12. 汎用タグ ID 検索

13. アノテーションタグ ID検索

取得対象

1. ファイルタイプ : ファイル・フォルダ・アルバム,ファイル,フォルダ・アルバム

2. ファイル拡張子: すべての拡張子,フォト拡張子ムービー拡張子, フォト・ムービー拡張子

3. png ファイル: フォト拡張子ファイル取得時に PNGファイルを取得する,

フォト拡張子ファイル取得時に PNG ファイルを取得しない


30

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/feed?q={q}&page={page}&showlimit={s

howlimit}&option={option}&sort={sort}&reload={reload}

検索方法、取得対象によって、クエリパラメータ、オプションパラメータの指定値が異なりますので、検索方

法別の指定値を参照してください。


ファイル・フォルダ名検索のときに fileType=file+extencion=photo を指定した場合は、フォト領域内(その他

アルバムを除く)のみを取得範囲とします。


1 1 q string ◯

クエリパラメータを指定

{key}={value}形式


(valueが URLエンコード済みの場合でも二重に

URL エンコード)

searchName%3d%2

5e3%2582%25b5%

25e3%2583%25b3

%25e3%2583%259

7%25e3%2583%25

ab%252cjpg


searchName=%e3%

82%b5%e3%83%b3

%e3%83%97%e3%

83%ab%2cjpg)


31

1 1 searchName string ◯

検索条件となるファイル名 (拡張子含む)、フォ

ルダ名、アルバム名


URL エンコード前で 256byte、全半角文字(半角

カタカナを除く)

オプションパラメータが以下の場合、

区切り文字(,)で複数文字列指定可(指定時は

AND 検索)

・fileType=all

・fileType=file+extension=all

・fileType=folder

オプションパラメータが以下の場合、

区切り文字(,)で複数文字列指定不可

・fileType=file+extension=photo

%e3%82%b5%e3%

83%b3%e3%83%97

%e3%83%ab%2cjp

g


サンプル,jpg)

2 2 page string

取得するページ番号

0~7byte、半角数字(1～9999999)


対象がないページを指定してもエラーとしない

1

3 3 showlimit string

取得する 1ページの表示件数

0~3byte、半角数字(1～200)


100

4 4

option string

オプションパラメータを指定

{key}={value}形式

オプションパラメータ複数指定時は

{key}={value}+{key}={value}形式


fileType%3dfile%2b

extension%3dphot

o

(エンコード前：

fileType=file+exten

sion=photo)

1 fileType string

取得するファイルタイプを指定

・all:ファイル・フォルダ・アルバム

・file:ファイル

・folder:フォルダ・アルバム

キー未指定時、空値指定時は「all」

file

2 extension string

fileType=file 指定時に取得する拡張子を指定

・all:すべての拡張子

・photo:フォト拡張子

・movie:ムービー拡張子

・photomovie:フォト・ムービー拡張子


photo


32

5 5 sort string

取得する一覧のソート順を指定

1：名前(昇順)、作成日時(降順)

2：名前(降順)、作成日時(降順)

3：作成日時(昇順)、名前(昇順)

4：作成日時(降順)、名前(昇順)

5：撮影日時(昇順)、名前(昇順)

6：撮影日時(降順)、名前(昇順)

0、指定なし：作成日時(降順)、名前(昇順)

0

6 6 reload string


・off:キャッシュを利用、ない場合は最新情報を

取得

・on:最新情報を取得


on

2. フォルダ ID検索

フォルダ ID検索では、ファイル・フォルダ名を指定した場合と指定しない場合で取得対象が変わります。

ファイル・フォルダ名を指定した場合は、サブフォルダを含む指定したフォルダ ID配下のファイル・フォルダ

を検索対象とします。

ファイル・フォルダ名を指定しない場合は、指定したフォルダ ID直下にあるファイル・フォルダのみを検索

対象とします。


1 1

q string ◯


{key}={value}形式

クエリパラメータを複数指定時は、





searchName%3dsa

mple%2bsearchFol

derId%3d12345670


searchName=sampl

e+searchFolderId=1

2345670)

1 searchName string

検索条件となるファイル名 (拡張子含む)、フォ

ルダ名、アルバム名




フォルダ ID にファイル領域ルートフォルダまた

はフォルダの IDを指定した場合、区切り文字(,)

で複数文字列指定可(指定時は AND 検索)

%e3%82%b5%e3%

83%b3%e3%83%97

%e3%83%ab

(エンコード前：サン

プル)


33

2 searchFolderId string ◯

検索条件となるフォルダ ID

または特別なフォルダを表す指定値

0~20byte、半角英数字

特別なフォルダを表す指定値

空値:ユーザルートフォルダ

elsePhotoAlbum：その他アルバム (フォト)

elseMovieAlbum：その他アルバム (ムービー)

12345670

2 2 page string


0~7byte、半角数字(1～9999999)



1


取得する 1 ページの表示件数



100

4 4

option string


{key}={value}形式

オプションパラメータを複数指定時は



fileType%3dall


fileType=all)

1 1 fileType string


・all:ファイル・フォルダ・アルバム


・folder:フォルダ・アルバム


file

2 2 pngFlg string

searchFolderId=elsePhotoAlbum 指定時に PNG

ファイルを取得するかを指定

・off:PNG ファイルを含めない

・on:PNG ファイルを含める


off


34

5 5 sort string









searchFolderId 指定値別ソート順

・ユーザルートフォルダ(空値)指定時は以下の

順で出力

-ファイル領域ルートフォルダ

-フォト領域ルートフォル

-ムービー領域ルートフォルダ

・ファイル領域ルートフォルダ ID 指定時は以下

の順で出力

-ストックフォルダ

-特殊フォルダ（存在しない場合は出力なし）

-ファイル・フォルダ（指定したソート順）

・フォト領域ルートフォルダ IDまたはムービー

領域ルートフォルダ ID 指定時は以下の順で出

力

-ストックアルバム

-アルバム（指定したソート順）

-その他アルバム

0

6 6 reload string



取得



on

3. タグ ID検索


1 q string ◯


{key}={value}形式


searchTagId%3d1


searchTagId=1)


35

1 1 searchTagId string ◯

検索条件となるタグ ID

タグ一覧取得 API で取得したタグ ID を指定


空値指定時は、タグ ID なしファイルを取得

1

2 2 page string


0~7byte、半角数字(1～9999999)



1





100

4 4

option string


{key}={value}形式




fileType%3dfile%2b

extension%3dphot

o


fileType=file+exten

sion=photo)

1 1 fileType string



キー未指定時、空値指定時は「file」

file

2 2 extension string







photo

3 3 pngFlg string

extension=photo 指定時に PNG ファイルを取

得するかを指定

・off:PNG ファイルを取得対象に含めない

・on:PNG ファイルを取得対象に含める


off


36

5 5 sort string









0

6 6 reload string



取得



on


ファイルを対象とした検索（fileType=file+extencion=allを指定）のときは、撮影日を基に検索を行い、撮影日が

設定されていないファイルは作成日を基に検索を行う。

フォトやムービーを対象とした検索（fileType=file+extencion=photo or movielを指定）のときは、撮影日を基に

検索を行い、撮影日が設定されていないファイルは取得対象となりません。

撮影日はマイポケで保存している撮影日、作成日はマイポケットに登録した日となります。


1 1

q string ◯


{key}={value}形式




searchStartDate%3

d2013%2d01%2d0

1


searchStartDate=20

13-01-01)

1 searchStartDate string ◯

検索条件となる撮影日/作成日

yyyy-MM-dd形式 (※1)

撮影日/作成日

・extension=allの場合:

撮影日のないファイルは作成日で検索

・extension=photo、movieの場合:

撮影日のないファイルは取得対象外

2013-01-01


37

2 searchPastYears string

検索条件となる撮影日/作成日の遡り年数

半角数字(1~100)

開始日付を指定せずに遡り取得年を指定した

場合はエラーとする

10

2 2 page string


0~7byte、半角数字(1～9999999)



1





100

4 4

option string


{key}={value}形式




fileType%3dfile%2b

extension%3dphot

o


fileType=file+exten

sion=photo)

1 1 fileType string


・file:ファイルのみ


file








photo

5 5 sort string









0

6 6 reload string



取得



on


38



フォト領域内(その他フォトアルバムを除く)のみを検索対象とします。


1 1

q string ◯


{key}={value}形式






searchStartDate%3

d2014%2d01%2d0

1%2bsearchEndDat

e%3d2014%2d01%

2d31


searchStartDate=20

14-01-01+searchEn

dDate=2014-01-31)

1 1 searchName string

検索するファイル名 (拡張子含む)




%e3%82%b5%e3%

83%b3%e3%83%97

%e3%83%ab


サンプル)

2 2 searchStartDate string ◯ 検索条件となる撮影日/作成日の開始日付

yyyy-MM-dd形式 (※1) 2014-01-01

3 3 searchEndDate string ◯ 検索条件となる撮影日/作成日の終了日付

yyyy-MM-dd形式 (※1) 2014-01-31

4 searchPastYear

s string

検索条件となる撮影日/作成日の遡り年数

半角数字(1~100)

開始日付を指定せずに遡り取得年を指定し

た場合はエラーとする

10

2 2 page string


0~7byte、半角数字(1～9999999)



1





100

4 4 option string


{key}={value}形式


fileType%3dfile%2b

extension%3dphot

o


39




fileType=file+exten

sion=photo)

1 fileType string




file

2 extension string





キー未指定時、空値指定時は「photo」

photo

5 5 sort string









0

6 6 reload string



取得



on




1 1

1

1

q string ◯


{key}={value}形式


searchLocation%3d

10_110_20_120


searchLocation=10

_110_20_120)


40

1 searchLocation string ◯

検索条件となる撮影場所/更新場所


南西緯度,南西経度,北東緯度,北東経度の順

に 4 つ指定

符号(-),小数点(.),区切り文字(_)

緯度: -90 ～ +90、経度: -180 ～ +180

10.1234567890123_

110.123456789012

3_20.12345678901

23_120.123456789

0123

2 2 page string


0~7byte、半角数字(1～9999999)



1





100

4 4

option string


{key}={value}形式




fileType%3dfile%2b

extension%3dall


fileType=file+exten

sion=all)

1 fileType string




file

2 extension string







all

5 5 sort string









0


41

6 6 reload string



取得



on


7. ファイルタイプ ID検索


1 1

q string ◯


{key}={value}形式






searchFileType%3d

0002


searchFileType=000

2)

1 searchName string

検索条件となるファイル名 (拡張子含む)




区切り文字(,)で複数文字列指定可(指定時は

AND 検索)

%e3%82%b5%e3%

83%b3%e3%83%97

%e3%83%ab


サンプル)

2 searchFileTyp

eId string ◯

検索条件となるファイルタイプ ID

ファイルタイプ一覧取得APIで取得したファ

イルタイプ ID を指定

半角数字

4byte(0 埋めした数字列)

0002

2 2 page string


0~7byte、半角数字(1～9999999)



1





100


42

4 4

option string


{key}={value}形式




fileType%3dfile%2b

extension%3dall


fileType=file+exten

sion=all)

1 fileType string




file

2 extension string




all

5 5 sort string









0

6 6 reload string



取得



on


8. シーン ID検索


1 1 q string ◯


{key}={value}形式


searchSceneId%3d

100_101


searchSceneId=100

_101)


43

1 1 searchSceneId string ◯

検索条件となるシーン ID

シーン分類一覧取得APIで取得したシーン ID

を指定

半角数字

区切り文字(_)で 2 要素まで指定可(指定時は

AND 検索)

100_101

2 2 page string


0~7byte、半角数字(1～9999999)



1





100

4 4

option string


{key}={value}形式




fileType%3dfile%2be

xtension%3dphoto


fileType=file+exten

sion=photo)

1 1 fileType string




file





photo

5 5 sort string









-

6 6 reload string



取得



on



44

9. 人物 ID検索


1 1

q string ◯


{key}={value}形式


searchFaceId%3d10

0000


searchFaceId=1000

00)

1 searchFaceId string ◯

検索条件となる人物 ID

人物一覧取得 API で取得した人物 ID を指定

半角英字

100000

2 2 page string


0~7byte、半角数字(1～9999999)



1





100

4 4

option string


{key}={value}形式




fileType%3dfile%2b

extension%3dphot

o (エンコード前：

fileType=file+exten

sion=photo)

1 fileType string




file

2 extension string




photo

5 5 sort string









-


45

6 6 reload string



取得



on




1

q string ◯


{key}={value}形式


searchFaceGroupId

%3d100000


searchFaceGroupId

=100000)

1 searchFacegro

upId string ◯

検索条件となる人物グループ ID

人物グループ一覧取得APIで取得した人物 ID

を指定

半角英字

100000

2 page string


0~7byte、半角数字(1～9999999)



1

3 showlimit string




100

4

option string


{key}={value}形式




fileType%3dfile%2be

xtension%3dphoto


fileType=file+exten

sion=photo)

1 fileType string




file

2 extension string




photo


46

5 sort string









-

6 reload string



取得



on




1

q string ◯


{key}={value}形式




searchGender %3d1


searchGender =1)

1 searchAgeMin string

検索条件となる年齢、または検索条件となる

年齢の下限値

半角数字(0~999)

0

2 searchAgeMax string 検索条件となる年齢の上限値

半角数字(0~999) 100

3 searchGender string

検索条件となる性別

1:男

2:女

1


47

4 searchExpressi

on string

検索条件となる表情タイプと表情%値

[表情タイプ]_[%値を表す整数]形式、または

[表情タイプ]のみの形式

表情タイプ：1 桁(1～7)

%値を表す整数：前 0 なし 3 桁(0～100)

表情タイプ

1：無表情

2：喜

3：驚

4：怒

5：悲

6：恐

7：嫌

5_40

6

5 searchEyes string

検索条件となる視線

[視線対象]_[視線タイプ]形式

視線対象：半角英字 1 桁(o,a)

視線タイプ：半角数字 1 桁(1～2)

視線対象

o：視線タイプが 1 つ以上存在するフォト

a：視線タイプが全て一致しているフォト

視線タイプ

1：正面

2：その他

o_1

o_2

a_1

a_2

6 searchCloseEy

es string

検索条件となる目つむり

[目つむり対象]_[目つむりタイプ]形式

目つむり対象：半角英字 1 桁(o,a)

目つむりタイプ：半角数字 1 桁(1～3)

目つむり対象

o：目つむりタイプが 1 つ以上存在するフォト

a：目つむりタイプが全て一致しているフォト

目つむりタイプ

1：目ひらき

2：目つむり

3：ウィンク

o_1

o_2

o_3

a_1

a_2

a_3


48

2 page string


0~7byte、半角数字(1～9999999)



1

3 showlimit string




100

4

option string


{key}={value}形式




fileType%3dfile%2be

xtension%3dphoto


fileType=file+exten

sion=photo)

1 fileType string




file

2 extension string




photo

5 sort string









-

6 reload string



取得



on


12. 汎用タグ ID検索



49

1

q string ◯


{key}={value}形式


searchUtilityTagId

%3d100000


searchUtilityTagId

=100000)

1 searchUtilityTa

gId( string

OR 検索用汎用 ID

接頭辞(t)：汎用 ID 値をタグ ID として検索

接頭辞(s)：汎用 ID 値をシーン ID として検索

接頭辞(f)：汎用 ID 値を人物 ID として検索

接頭辞(a)：汎用 IDに指定した値をアノテーショ

ンタグ ID として検索

各要素は[接頭辞]+[半角数字]形式

10 要素まで指定可、区切り文字(_)

t1_t2_s100_s102_f

100001_a1001

2 page string


0~7byte、半角数字(1～9999999)



1

3 showlimit string




100

4

option string


{key}={value}形式




fileType%3dfile%2be

xtension%3dphoto


fileType=file+exten

sion=photo)

1 fileType string




file

2 extension string






photo


50

5 sort string









-

6 reload string



取得



on


13. アノテーションタグ ID検索


1

q string ◯


{key}={value}形式


searchAnnoTagId %

3d1001


searchAnnoTagId

=1001)

1 searchAnnoTa

gId string

検索条件となるアノテーションタグ ID

タグ一覧取得 API で取得したタグ ID を指定


1

2 page string


0~7byte、半角数字(1～9999999)



1

3 showlimit string




100

4 option string


{key}={value}形式




fileType%3dfile%2be

xtension%3dphoto


fileType=file+exten

sion=photo)


51

1 １ fileType string




file

2 extension string






photo

3 pngFlg string

extension=photo 指定時に PNG ファイルを取

得するかを指定

・off:PNG ファイルを取得対象に含めない

・on:PNG ファイルを取得対象に含める


off

5 sort string









-

6 reload string



取得



on




1 1 Authorization string ◯ 「1.2 トークン認証」参照

2 2 X-Authorization string ◯ 「1.2 トークン認証」参照

3 3 Content-Type string ◯ 「application/json」を指定





52



1 1 parentFolderId string

上位フォルダ ID

半角数字

キー出力条件

「2.フォルダ ID 検索」で、フォルダ IDに通常フォ

ルダを指定し、かつ上位フォルダがファイル領域

ルートフォルダでない場合のみ

1234567709

2 2

1. 1

.

8

files array ◯ 取得したファイル・フォルダの一覧

取得件数が 0件の場合は nullを返却

1 fileId string 取得したファイル・フォルダ ID

半角数字 1234567807

2 fileName string

取得したファイル・フォルダ・アルバム名

全半角文字

バックスラッシュエスケープシーケンス使用

サンプルファイル

3 folderKind string

取得したファイル・フォルダの種別

0: ファイル

1: 通常フォルダ

2: ストックフォルダ

3: フォトアルバム

4: フォトストックアルバム

5: ムービーアルバム

6: ムービーストックアルバム

7: その他アルバム(フォト)

8: その他アルバム(ムービー)

11 以降: 特殊フォルダ

各フォルダの説明は「4. マイポケットについて」

参照

キー出力条件

「2.フォルダ ID 検索」で、フォルダ IDにユーザル

ートフォルダ(空値)を指定した場合以外

0


53

4 comment string

取得したファイルのコメント

全半角文字(半角カタカナを除く)

バックスラッシュエスケープシーケンス使用

キー出力条件

・値がある場合のみ

サンプルコメントで

す。

5 issued string

取得したファイル・フォルダ・アルバムの作成日時


キー出力条件



2013-01-01T00:00:

00+09:00

6 modified string

取得したファイル・フォルダ・アルバムの更新日時


キー出力条件



2013-01-02T00:00:

00+09:00

7 shotDate string

取得したフォト拡張子ファイルの撮影日

yyyy-MM-dd 形式 (※1)

キー出力条件


2013-01-02

8 latitude string

取得したフォト拡張子ファイルの撮影場所/更新

場所(緯度)

半角数字(-90~90,整数部 2 桁,小数部 13桁 0埋

め)、記号(-.)

キー出力条件


35.6603650000000

9 longitude string

取得したフォト拡張子ファイルの撮影場所/更新

場所(経度)

半角数字(-180~180,整数部 3 桁,小数部 13 桁 0


キー出力条件


139.745394000000

0


54

10 movieTime string

取得したムービー拡張子ファイルの再生時間

HHHHHH:MM:SS形式

キー出力条件


123:45:00

11 fileCount string

取得したアルバム内のファイル数

半角数字(0 以上の整数)

アルバム内のファイル数が 0 の場合は空値を返

却

キー出力条件

「2.フォルダ ID 検索」で、フォルダ IDに

フォト領域ルートフォルダ、またはムービー領域

ルートフォルダを指定した場合のみ

5

12 lastAddFileId string

取得したアルバムに最後に追加したファイル ID

半角数字

アルバム内のファイル数が 0 の場合は空値を返

却

キー出力条件




1234567907

13 lastAddModi

fied string

取得したアルバムに最後に追加したファイルの

更新日時


キー出力条件




2013-01-05T00:00:

00+09:00

14 clockwiseRot

ateAngle string

正位置までの回転角度（時計回りに何度回転す

ると上向きになるかを表した値）

0: 無回転




90

15 photoHeight string 取得したオリジナルフォトの縦幅(px)

半角数字(0～999999) 10

16 photoWidth string 取得したオリジナルフォトの横幅(px)

半角数字(0～999999) 10


55

17 tagId array

取得したファイルのダグ ID


キー出力条件

「5.撮影期間検索」で、値がある場合のみ

1001,1002

18 sceneId array

取得したファイルのシーン ID


キー出力条件


301,302

19 faceId array

取得したファイルの人物 ID

半角数字(100000～199999)、格納する型：string

キー出力条件


100000,100020

20 annoTagId array

取得したファイルに紐づくアノテーションタグ ID（複

数可）


キー出力条件


1001,1002

3 3 page string ◯ 取得したページ番号

半角数字(1 以上の整数) 1

4 4 showLimit string ◯ 1 ページの表示件数


5 5 fileCount string ◯ 検索該当件数




56



ファイル名に"サンプル",”jpg"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchName%3d

%25e3%2582%25b5%25e3%2583%25b3%25e3%2583%2597%25e3%2583%25ab%252cjpg

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchName=サンプル,jpg)

2. フォルダ ID検索

フォルダ ID に通常フォルダ"12345670"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchFolderId%3d12345670

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchFolderId=12345670)

フォルダ ID に特殊なフォルダ(ユーザルートフォルダ：空値)を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchFolderId%3d

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchFolderId=)

3. タグ ID検索

タグ IDに"1"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchTagId%3d1&option=fileType%3dfile%2b

extension%3dphoto%2bpngFlg%3don

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchTagId=1&option=fileType=file+

extension=photo+pngFlg=on)


開始日に"2013-01-01"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchStartDate%3d2013%2d01%2d01

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchStartDate=2013-01-01)


開始日に"2013-01-01"を、終了日に"2013-01-31"を指定

GET https://cocoa.ntt.com /rest/storage/v1/feed?q=searchStartDate%3d2013%2d01%2d01%2b

searchEndDate%3d2013%2d01%2d31

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchStartDate=2013-01-01+

searchEndDate=2013-01-31)

https://cocoa.ntt.com/rest/storage/v1/feed?q=searchName%3d

https://cocoa.ntt.com/rest/storage/v1/feed?q=searchTagId=1&option

https://cocoa.ntt.com/rest/storage/v1/feed?q=searchStartDate=2013-01-01


57


場所範囲に"10.1234567890123_110.1234567890123_20.1234567890123_120.1234567890123"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchLocation%3d

10%2e1234567890123_110%2e1234567890123_20%2e1234567890123_120%2e1234567890123

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchLocation=

10.1234567890123_110.1234567890123_20.1234567890123_120.1234567890123)

7. ファイルタイプ検索

ファイルタイプに"0002"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchFileTypeId%3d0002

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchFileTypeId=0002)

8. シーン ID検索

シーン IDに"100"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchSceneId%3d100

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchSceneId=100)

9. 人物 ID検索

人物 IDに"100000"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchFaceId%3d100000

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchFaceId=100000)


人物グループ IDに"100000"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchFaceGroupId%3d100000

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q= searchFaceGroupId =100000)

https://cocoa.ntt.com/rest/storage/v1/feed?q=searchLocation%3d

https://cocoa.ntt.com/rest/storage/v1/feed?q=searchLocation


58


年齢に 20 歳以上且つ 30歳以下を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchAgeMin%3d20%2bsearchAgeMax%3d30

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchAgeMin=20+searchAgeMax=30)

性別に男を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchGender%3d1

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchGender=1)

表情に「喜び 80%以上」を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchExpression%3d2_80

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchExpression=2_80)

視線に「視線対象フォト上の全ての視線タイプが一致するフォト」、「視線タイプ正面」を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchEyes%3do_1

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchEyes=o_1)

目つむりに「目つむり対象フォト上の全ての視線タイプが一致するフォト」、「目つむりタイプウィンク」を

指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchCloseEyes%3do_3

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchCloseEyes=o_3)

12. 汎用タグ ID検索

タグ IDに"1"を指定、シーン ID に"100"を指定、人物 IDに"100000"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchUtilityTagId%3dt1_s100_f100000

(エンコード前：https://cocoa.ntt.com/rest/storage/v1/feed?q=searchUtilityTagId=t1_s100_f100000)

13. アノテーションタグ ID 検索

アノテーションタグ IDに"1001"を指定

GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchAnnoTagId%3d1001

(エンコード前: GET https://cocoa.ntt.com/rest/storage/v1/feed?q=searchAnnoTagId=1001)


59


HTTP/1.1 200 OK


ファイル/フォルダを取得 (extension=photo,movie 指定時以外)

{

"files": [

{

"fileId": "1234567890",

"fileName": "サンプルファイル.jpg",

"folderKind": "0"

"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00"

},

{

"fileId": "123456789",

"fileName": "サンプルフォルダ",

"folderKind": "1"

"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00"

}

],

"page": "1",

"showLimit": "100",

"fileCount": "2"

}

ファイルを取得 (extension=photo 指定時)

{

"files": {

"fileId": "1234567807",


"folderKind": "0"


"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00",

"shotDate": "2013-01-03"

"latitude": "35.6603650000000",

"longitude": "139.7453940000000",

"clockwiseRotateAngle": "0"

"photoHeight": "100",

"photoWidth": "100"

},

"page": "1",

"showLimit": "100",

"fileCount": "1"

}


60

ファイルを取得 (extension=movie指定時)

{

"files": {

"fileId": "1234567807",

"fileName": "サンプルファイル.3gp",

"folderKind": "0"

"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00",

"movieTime": "1:23:45"

},

"page": "1",

"showLimit": "100",

"fileCount": "1"

}

フォルダを取得 (「2.フォルダ ID 検索」で、ユーザルートフォルダ指定)

{

"files": [

{

"fileId":"93946309",

"fileName":"ファイル"

},

{

"fileId":"93946409",

"fileName":"フォト"

},

{

"fileId":"93946809",

"fileName":"ケータイムービー"

}

],

"page":"1",

"showLimit":"100",

"fileCount":"3"

}


61

フォルダを取得 (「2.フォルダ ID 検索」で、フォト領域ルートフォルダ指定)

{

"files": [

{

"fileId": "12345678",

"fileName": "ストックアルバム",

"folderKind": "4"


"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00",

"fileCount": "5",

"lastAddFileId": "1234567870",

"lastAddModified": "2013-01-02T00:00:00+09:00"

},

{

"fileId": "1234567807",

"fileName": "サンプルアルバム",

"folderKind": "3"

"comment": "",

"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00",

"fileCount": "0",

"lastAddFileId": "",

"lastAddModified": ""

},

{

"fileId": “elsePhotoAlbum",

"fileName": "その他アルバム",

"folderKind": "7"

"comment": "",

"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00",

"fileCount": "111",

"lastAddFileId": "123456789",

"lastAddModified": "2013-01-02T00:00:00+09:00"

}

],

"page": "1",

"showLimit": "100",

"fileCount": "3"

}


62

ファイル/フォルダを取得

(「2.フォルダ ID検索」で、ユーザルートフォルダ、各領域ルートフォルダ以外を指定)

{

"parentFolderId": "1234567809",

"files": [

{

"fileId": "1234567891",

"fileName": "サンプルファイル.txt",

"folderKind": "0"

"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00"

},

{

"fileId": "1234567892",


"folderKind": "0"

"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00"

},

{

"fileId": "123456789",

"fileName": "サンプルフォルダ",

"folderKind": "1"

"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00"

}

],

"page": "1",

"showLimit": "100",

"fileCount": "3"

}


63

ファイルを取得 (「5.撮影期間検索」)

{

"files": {

"fileId": "1234567807",


"folderKind": "0"


"issued": "2013-01-01T00:00:00+09:00",

"modified": "2013-01-02T00:00:00+09:00",

"shotDate": "2013-01-03",

"latitude": "35.6603650000000",

"longitude": "139.7453940000000",

"clockwiseRotateAngle": "0"

"photoHeight": "100",

"photoWidth": "100",

"tagId": ["1001", "1002"],

"sceneId": ["301", "302", "303"],

"faceId": ["100000","100020"],

"annoTagId": ["1001","1002"]

},

"page": "1",

"showLimit": "100",

"fileCount": "1"

}


64

5.7. フォルダ作成 API

作成するフォルダ・アルバムを格納するフォルダ ID（ファイル・フォルダ一覧検索 API で取得可能）と、

作成するフォルダ・アルバム名を指定して、フォルダ・アルバムを作成します。

アルバムを作成する場合は上位フォルダ ID に、フォト領域ルートフォルダ、ムービー領域ルートフ

ォルダを指定します。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/folders/{parentFolderId}


1 parentFolderId string ◯ 作成するフォルダを格納するフォルダ ID

半角数字 12345670









1 title string ◯ 作成するフォルダ・アルバム名 (※1)

全半角文字(半角カタカナを除く) サンプルフォルダ

2 comment string

作成するフォルダ・アルバムのコメント

(※1)



です。


https://cocoa.ntt.com/rest/storage/v1/folders/%7bparentFolderId%7d


65



1. Content-Type string ◯ コンテンツタイプ application/json



1 folderId string ○ 作成したフォルダ ID

半角数字 12345680

2 title string ◯ 作成したフォルダ・アルバム名 (※1)


3 comment string ◯

作成したフォルダ・アルバムのコメント

(※1)



です。

4 issued string ◯ 作成したフォルダ・アルバムの作成日時


2013-01-01T00:00:

00+09:00




POST https://cocoa.ntt.com/rest/storage/v1/folders/12345670




Content-Length:82

{

"title": "サンプルフォルダ",

"comment": "サンプルコメントです。"

}


66




{

"folderId": "12345680",



"issued": "2013-01-01T00:00:00+09:00"

}


67

5.8. フォルダ取得 API

取得するフォルダ ID（ファイル・フォルダ一覧検索 API で取得可能）を指定して、フォルダ・アルバムの属性

情報を取得します。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/folders/{folderId}?reload={reload}


1 folderId string ◯ 取得するフォルダ ID

半角数字 12345680

2 reload string



取得



on











1 title string ◯ 取得したフォルダ名 (※1)


https://cocoa.ntt.com/rest/users/v1/service?type=%7btype%7d


68

2 comment string ◯ 取得したフォルダのコメント (※1)



です。

3 issued string ◯ 取得したフォルダの作成日時


2013-01-01T00:00:

00+09:00

4 modified string ◯ 取得したフォルダの更新日時


2013-01-02T00:00:

00+09:00





GET https://cocoa.ntt.com/rest/storage/v1/folders/12345680




HTTP/1.1 200 OK


{



"issued": "2013-01-01T00:00:00+09:00",

"modified: "2013-01-02T00:00:00+09:00"

}


69

5.9. フォルダ変更 API

変更するフォルダ ID（ファイル・フォルダ一覧検索 API で取得可能）と変更後のフォルダ名を指定して、

フォルダ・アルバムを変更します。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/folders/{folderId}


1 folderId string ◯ 変更するフォルダ ID

半角数字 12345680









1 title string ◯ 変更後のフォルダ・アルバム名 (※1)


サンプルフォルダ

２

2 comment string

変更後のフォルダ・アルバムのコメント

(※1)



２です。



70






1 title string ○ 変更したフォルダ・アルバム名 (※1)



２

2 comment string ◯

変更したフォルダ・アルバムのコメント

(※1)



２です。

3 modified string ◯ 変更したフォルダ・アルバムの変更日時


2013-01-01T00:00:

00+09:00

4 parentTitle string

変更したフォルダが格納されているフォル

ダ名

変更したフォルダが格納されているフォルダが

以下の場合はキー及び値なし





１




PUT https://cocoa.ntt.com/rest/storage/v1/folders/12345680




Content-Length:139

{

"title": "サンプルフォルダ２",

"comment": "サンプルコメント２です。"

}


71


HTTP/1.1 200 OK


{

"title": "サンプルフォルダ２",

"comment": "サンプルコメント２です。",

"modified: "2013-01-02T00:00:00+09:00",

"parentTitle": "サンプルフォルダ１"

}


72

5.10. フォルダ移動 API

移動するフォルダ ID と移動先のフォルダ ID を指定して、フォルダ・アルバムを移動します。

（フォルダ ID はファイル・フォルダ一覧検索 API で取得可能）

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/folders/move









1 sourceFolderId string ◯

移動するフォルダ ID

以下のフォルダは移動不可

・アルバムまたは各種ルートフォルダ

・移動先フォルダと同じフォルダ

12345680

2 targetFolderId string ◯

移動先のフォルダ ID

以下のフォルダへの移動不可

・アルバム

・移動するフォルダ配下にあるフォルダ

12345670





73



1 sourceTitle string ○ 移動したフォルダ・アルバム名 (※1)

全半角文字(半角カタカナを除く) サンプルフォルダ２

2 targetTitle string

移動先のフォルダ・アルバム名 (※1)


移動先のフォルダが以下の場合はキー及び値

なし




サンプルフォルダ１




PUT https://cocoa.ntt.com/rest/storage/v1/folders/move




Content-Length:57

{

"sourceFolderId": "12345680",

"targetFolderId": "12345670"

}

HTTP/1.1 200 OK


{

"sourceTitle": "サンプルフォルダ２",

"targetTitle": "サンプルフォルダ１",

}


74

5.11. タグ登録 API

登録するタグ(※)を指定して、タグを登録します。

※タグとは、ファイルを分類するための短い単語やフレーズです。フォルダのような階層構造を持たないの

でより柔軟な分類が可能です。

※マイポケットの UIでは、タグをラベルという名称で利用しております.。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/tags









1 title string ◯

登録するタグ (※1)

全半角文字 (全半角スペース、全半角カン

マ、半角カタカナを除く)

ラベル






75



1 tagId String ○ 登録したタグ ID

半角数字 12345678

2 title string ◯

登録したタグ (※1)



ラベル

3 issued string ◯ 登録したタグの作成日時


2012-12-12T14:33:

01+09:00




POST https://cocoa.ntt.com/rest/storage/v1/tags




{

"title":"ラベル"

}


Content-Type:applicationi/json

{

"tagId":"12345678",

"title":"ラベル",

"issued":"2012-12-12T14:33:01+09:00"

}



76

5.12. タグ一覧取得 API

登録したタグ(※)一覧（タグ ID、タグ）を取得します。

※タグとは、ファイルを分類するための短い単語やフレーズです。フォルダのような階層構造を持たないの

でより柔軟な分類が可能です。

※マイポケットの UIでは、タグをラベルという名称で利用しております。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/tags?reload={reload}


1 page string 取得するページ番号

0~7byte、半角数字(1～9999999)



1

2 showlimit string 取得する 1ページの表示件数


キー未指定、空値指定時は全件表示として処理

する。

100

3 sort string 取得する一覧のソート順を指定

1：タグ名(昇順)

2：タグ名(降順)

3：作成日時(昇順)

4：作成日時(降順)

0

4 reload string



取得



on






https://cocoa.ntt.com/rest/storage/v1/tags?reload=%7breload%7d


77






1

tags array ◯

取得したタグ一覧

タグ IDの昇順出力

タグ登録なしの場合は nullを返却

1 tagId string

取得したタグ ID

半角数字 1

2 annoTagId string

取得したアノテーションタグ ID

半角数字 1

3

title string ◯

取得したタグ (※1)

全半角文字（全半角スペース、全半角カンマ、半

角カタカナを除く）

サンプルタグ１

4

annoTagAlias string

アノテーションタグ別名

全半角文字。(全半角スペース、全半角カンマ、半

角カタカナを除く。)

サンプルタグ別

名１

5 annoTagVisibl

eFlg string

取得したアノテーションタグ表示フラグ

0:非表示

1:表示

1

6 passphrase string

取得したタグに設定されているパスフレーズ

全角文字（ひらがなのみ）あかさたなは

7

password string

取得したタグに設定されているパスフレーズに対

応するパスワード

全角文字（ひらがなのみ）

いきしちにひ

8 issued string ◯

取得したタグの作成日時


2013-01-01T00:0

0:00+09:00

9 modified string ◯

取得したタグの更新日時


2013-01-02T00:0

0:00+09:00

2 page

string ○ 取得したページ番号


3 showlimit

string 1 ページあたりの取得件数


4 totalCount

string ○ 検索該当件数





78



HTTP/1.1 200 OK


タグ情報が存在する場合

{

"tags": [

{

"tagId": "1",

"title": "サンプルタグ 1",

"passphrase": "あかさたなは",

"password": "いきしちにひ",

"issued": "2013-01-01T00:00:00+09:00",

"moddifed": "2013-01-02T00:00:00+09:00"

},

{

"tagId": "2",

"title": "サンプルタグ 2",

"issued": "2013-02-01T00:00:00+09:00",

"moddifed": "2013-02-01T00:00:00+09:00"

}

]

}

タグ情報が存在しない場合

{

"tags": null

}

GET https://cocoa.ntt.com/rest/storage/v1/tags





79

5.13. タグ変更 API

変更するタグ ID と変更後のタグを指定して、タグ（ラベル）を変更します。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/tags/{tagId}


1 tagId string ◯ 変更するタグ ID

半角数字 12345

2 type string

変更するタグ

0：タグ(手動タグ)

1：アノテーションタグ

1









1 title string

変更するタグ(※1)



ラベル

2 passphraseSetu

p string

タグに設定するパスフレーズ設定モード

0：設定されているパスフレーズを削除

1：パスフレーズを新規発行

1

3 annoTagAlias string

設定するアノテーションタグ別名

全半角文字(全半角スペース、全半角カンマ、

半角カタカナを除く)

テスト

https://cocoa.ntt.com/rest/storage/v1/tags/%7btagId%7d


80

4 annoTagVisibleF

lg string

変更するアノテーションタグ表示フラグ

0：非表示

1：表示

1







1 1 title string ◯

変更したタグ (※1)



ラベル

2 2 passphrase string タグに設定されているパスフレーズ

全角ひらがな 6 文字あかさたな

3 3 password String

タグに設定されているパスフレーズに対応

するパスワード

全角ひらがな 6 文字

いきしちに

4 4 annoTagAlias string

変更したアノテーションタグ別名(※1)

全半角文字(全半角スペース、全半角カンマ、

半角カタカナを除く)

テスト

5 5 annoTagVisibleFl

g string 変更したアノテーションタグ表示フラグ 1

6 modified string ◯ 変更したタグの変更日時


2012-12-12T14:33:

01+09:00




81



PUT https://cocoa.ntt.com/rest/storage/v1/tags/12345




Content-Length:52

passphraseSetup=0 の場合

{

"title":"ラベル"

"passphraseSetup":"0"

}

passphraseSetup指定なしの場合

{

"title":"ラベル"

}

type=1 の場合

PUT /rest/storage/v1/tags/12345?type=1

{

"annoTagAlias":"タグ別",

"annoTagVisibleFlg":"1"

}

HTTP/1.1 200 OK



パスフレーズが設定されていない状態で passphraseSetup 指定なしの場合

{

"title":"変更したラベル名",

"modified":"2012-12-12T14:33:01+09:00"

}


パスフレーズが設定されている状態で passphraseSetup指定なしの場合

{

"title":"変更したラベル名",

"passphrase":"あかさたなは",

"password":"いきしちにひ",

"modified":"2012-12-12T14:33:01+09:00"

}



82

type=1 の場合

{

"annoTagAlias":"タグ別",

"annoTagVisibleFlg":"0",

"modified":"2013-05-20T06:30:30+09:00"

}


83

5.14. タグ削除 API

削除するタグ ID を指定して、タグ（ラベル）を削除します。

リクエスト URI

HTTP メソッド：DELETE文字コード：UTF-8

https://cocoa.ntt.com/rest/storage/v1/tags/{tagId}


1 tagId string ◯ 削除するタグ ID

半角数字 123456











5.15.

DELETE https://cocoa.ntt.com/rest/storage/v1/tags/123456




HTTP/1.1 200 OK


https://cocoa.ntt.com/rest/storage/v1/tags/%7btagId%7d



84

シーン分類一覧取得 API

マイポケットが設定しているシーン分類(※) 一覧（シーンカテゴリ ID、シーンカテゴリ名、シーン ID、シーン名）

を取得します。

※シーン分類とは、マイポケットのフォト拡張子ファイルを自動的にシーンカテゴリ、シーンへ分類したものです。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/scenes?reload={reload}


1 reload string



取得



on











1

scenesList array ◯ 取得したシーン分類の一覧

1 sceneCategoryId string ◯ 取得したシーンカテゴリ ID

半角数字 300

https://cocoa.ntt.com/rest/storage/v1/scenes?reload=%7breload%7d


85

2 sceneCategory

Name string ◯

取得したシーンカテゴリ名 (※1)

全半角文字カテゴリ名

3 sceneId string ◯ 取得したシーン ID

半角数字 100

4 sceneName string ◯ 取得したシーン名 (※1)

全半角文字シーン名




GET https://cocoa.ntt.com/rest/storage/v1/scenes




HTTP/1.1 200 OK


{

"scenesList":[

{ "sceneCategoryId":"3","sceneCategoryName":"風景","sceneId":"301","sceneName":"お花" },

{ "sceneCategoryId":"3","sceneCategoryName":"風景","sceneId":"302","sceneName":"夜景" },

{ "sceneCategoryId":"3","sceneCategoryName":"風景","sceneId":"305","sceneName":"雪景色" },

{ "sceneCategoryId":"3","sceneCategoryName":"風景","sceneId":"304","sceneName":"トワイライト" },

{ "sceneCategoryId":"3","sceneCategoryName":"風景","sceneId":"303","sceneName":"サンセット" },

{ "sceneCategoryId":"3","sceneCategoryName":"風景","sceneId":"306","sceneName":"自然" },

{ "sceneCategoryId":"4","sceneCategoryName":"料理","sceneId":"401","sceneName":"料理" },

{ "sceneCategoryId":"1","sceneCategoryName":"顔検出","sceneId":"101","sceneName":"1 人" },

{"sceneCategoryId":"1","sceneCategoryName":"顔検出","sceneId":"102","sceneName":"2 人" },

{"sceneCategoryId":"1","sceneCategoryName":"顔検出","sceneId":"103","sceneName":"3 人以上" },

{"sceneCategoryId":"1","sceneCategoryName":"顔検出","sceneId":"100","sceneName":"0 人" },

{"sceneCategoryId":"2","sceneCategoryName":"ペット","sceneId":"201","sceneName":"ペット" },

{"sceneCategoryId":"2","sceneCategoryName":"ペット","sceneId":"200","sceneName":"ペットなし" }

]

}

https://cocoa.ntt.com/rest/storage/v1/scenes


86

5.16. ファイルタイプ一覧取得 API

マイポケットが設定しているファイルタイプ(※)一覧（ファイルタイプ ID、ファイルタイプ名）を取得します。

※ファイルタイプとは、ファイルの種別です。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/type?reload={reload}


1 reload string



取得



on











1

fileTypeList array ◯ 取得したファイルタイプの一覧 -

1 fileTypeId string ◯ 取得したファイルタイプ ID

0 埋めした数字列 0001

https://cocoa.ntt.com/rest/storage/v1/


87

2 fileTypeName string ◯ 取得したファイルタイプ名 (※1)

全半角文字文書




GET https://cocoa.ntt.com/rest/storage/v1/type




HTTP/1.1 200 OK


{

"fileTypeList":[

{ "fileTypeId":"0002", "fileTypeName":"文書" },

{ "fileTypeId":"0003", "fileTypeName":"表" },

{ "fileTypeId":"0004", "fileTypeName":"プレゼンテーション" },

{ "fileTypeId":"0005", "fileTypeName":"データベース" },

{ "fileTypeId":"0006", "fileTypeName":"実行形式" },

{ "fileTypeId":"0007", "fileTypeName":"圧縮" },

{ "fileTypeId":"0008", "fileTypeName":"TEXT" },

{ "fileTypeId":"0009", "fileTypeName":"PDF" },

{ "fileTypeId":"0010", "fileTypeName":"画像" },

{ "fileTypeId":"0011", "fileTypeName":"動画" },

{ "fileTypeId":"0012", "fileTypeName":"HTML" },

{ "fileTypeId":"0014", "fileTypeName":"AUDIO" },

{ "fileTypeId":"0000", "fileTypeName":"その他" }

]

}


88

5.17. ZIP 作成 API

圧縮するファイル ID を指定して、ZIP圧縮ファイルを作成します。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/files/compress









1 fileId

array ◯

圧縮するファイル ID



複数選択する場合は、配列で指定

10000107,10000207






1 compressId string ○ 圧縮管理 ID 1000


89



POST https://cocoa.ntt.com/rest/storage/v1/files/compress




Content-Length:34

{

"fileId":["10000107","10000207"]

}



{

" compressId":": "1000",

}


90

5.18. ZIP 進捗結果 API

圧縮管理 ID（ZIP 作成 APIで取得可能）を指定して、圧縮管理 ID の進捗ステータスを取得します。

リクエスト URI


https://cocoa.ntt.com/rest/storage/v1/files/compress/{compressId}


1 compressId string ◯ 取得する圧縮管理 ID

半角数字 1000











1 fileId string

圧縮ファイル ID

キー出力条件

ZIP 圧縮が正常終了している場合

ZIP 圧縮のファイル名は現在日時

(yyyyMMddHHmmss)とし、重複する場合（1）等

の項番を付与したファイル名とする。

10000107


91

2 fileNum string

圧縮ファイルの全件数

キー出力条件

ZIP 圧縮が未処理、圧縮中の場合

100

3 endFileNum string

圧縮済みのファイル件数

キー出力条件

ZIP 圧縮が未処理、圧縮中の場合

30

4 status string ○

進捗ステータス

0:未処理

1:圧縮中

2:正常終了

3:エラー終了

4:容量エラー

2



GET https://cocoa.ntt.com/rest/storage/v1/files/compress/1000




HTTP/1.1 200 OK


ZIP 圧縮が正常終了の場合

{

"fileId": "10000107",

"status": "2"

}

ZIP 圧縮未処理、ZIP 圧縮中の場合

{

"fileNum": "100",

"endFileNum": "30",

"status": "1"

}

ZIP 圧縮エラーの場合

{

"status": "3"

}

ZIP 容量エラーの場合

{

"status": "4"

}


92

5.19. 人物一覧取得 API

登録した人物一覧（人物 ID、人物名、人物 IDに紐づくファイル数、人物 IDに最後に追加したファイル ID）を

取得します。

リクエスト URI


https://cocoa.ntt.com/rest/recognition/v1/face?reload={reload}


1 reload string



取得



on









https://cocoa.ntt.com/rest/recognition/v1/face?reload=%7breload%7d


93



1

faceList array ○

取得した人物の一覧

人物名の昇順出力

人物登録なしの場合は nullを返却

1 1 faceId string ◯ 取得した人物 ID

半角数字 100000

2 faceName string ◯

取得した人物名 (※1)

全半角文字(半角カタカナ、半角カンマ、全角カ

ンマを除く)

AAA

3 faceCount string ◯ 取得した人物 ID に紐付くファイル数

半角数字 2

4 fileId string ◯

取得した人物 ID に最後に追加したファイル

ID

半角文字

取得した人物 ID に紐付くファイルがない場

合は空値を返却

12345678907

5 passphrase string 取得した人物に設定されているパスフレーズ

全角文字（ひらがなのみ）あかさたなは

6 password string

取得した人物に設定されているパスフレー

ズに対応するパスワード

全角文字（ひらがなのみ）

いきしちにひ

7 issued string ◯ 取得した人物 ID の作成日時


2013-08-01T00:00:

00+09:00




GET https://cocoa.ntt.com/rest/recognition/v1/face




https://cocoa.ntt.com/rest/recognition/v1/face


94


HTTP/1.1 200 OK


{

"faceList":[

{

"faceId":"100000",

"faceName":"AAA",

"faceCount":"2" ,

"fileId":"12345678907" ,

"issued":"2013-08-01T00:00:00+09:00"

},

{

"faceId":"100001",

"faceName":"BBB",

"faceCount":"5" ,

"fileId":"13579246807" ,



"issued":"2013-08-03T14:00:00+09:00"

},

{

"faceId":"100002",

"faceName":"CCC",

"faceCount":"3" ,

"fileId":"12358132107" ,

"issued":"2013-08-10T23:59:00+09:00"

}

]

}


95

5.20. 人物登録 API

登録する人物情報（人物名、人物を表すファイル ID、顔位置情報）を指定して、人物を登録します。

リクエスト URI












登録する人物名(※1)

全半角文字(半角カタカナ、半角カンマ、全

角カンマを除く)

登録済みの人物名はエラー

DDD

2

faceFileCoordina

teList array ◯

登録する人物を表すファイル ID と顔位置情

報のリスト

1 faceFileId string ◯

人物を表すファイル ID

拡張子が、jpeg、jpg、jfif、jpe のファイルの

み指定可

12345678907

2 faceCoordina

tes string ◯

顔位置情報



左上 X_左上 Y_右上 X_右上 Y_左下 X_左下 Y_

右下 X_右下 Y の順に「_」区切りで記述

109_126_380_131_

104_397_375_402



96






1 faceId string ◯ 登録した人物 ID

半角数字 100000


登録した人物名 (※1)



AAA

3

faceFileCoordinat

eList array ◯

登録した人物を表すファイル ID と顔位置情

報のリスト

1 faceFileId string ◯ 人物を表すファイル ID 12345678907

2 faceCoordinat

es string ◯

顔位置情






109_126_380_131

_104_397_375_40

2

4 issued string ◯ 登録した人物 ID の作成日時


2013-08-01T00:00:

00+09:00




97



POST https://cocoa.ntt.com/rest/recognition/v1/face




{

"faceName": "DDD",

"faceFileCoordinateList":[

{ "faceFileId": "12345678907", "faceCoordinates": "109_126_380_131_104_397_375_402" },

{ "faceFileId": "13579864207", "faceCoordinates":"54_62_190_65_52_198_180_201"}

]

}



{

"faceId":"100000",

"faceName": "DDD",



{ "faceFileId": "13579864207", "faceCoordinates": "54_62_190_65_52_198_180_201"}

],

"issued": "2013-08-03T14:05:00+09:00"

}



98

5.21. 人物取得 API

取得する人物 ID を指定して、人物情報（人物名、人物を表すファイル ID、顔位置情報）を取得します。

リクエスト URI


https://cocoa.ntt.com/rest/recognition/v1/face/{faceId}?reload={reload}


1 faceId string ◯

取得する人物 ID


半角数字

2 reload string



取得



on












取得した人物名 (※1)


ンマを除く)

AAA

https://cocoa.ntt.com/rest/recognition/v1/face/%7bfaceId%7d?reload=%7breload%7d


99

2

faceFileCoordinat

eList array ◯

取得した人物を表すファイル ID と顔位置情

報のリスト

ファイルがない場合は null を返却

1 faceFileId array




12345678907

2 faceCoordinates array

顔位置情報






109_126_380_131

_104_397_375_40

2

3 issued string ◯ 取得した人物の作成日時


2013-08-01T00:00:

00+09:00

4 modified string ◯ 取得した人物の最終更新日時


2013-08-09T12:00:

00+09:00





GET https://cocoa.ntt.com/rest/recognition/v1/face/100000




HTTP/1.1 200 OK


{

"faceName": "AAA",


{

"faceFileId": "12345678907",

"faceCoordinates": "109_126_380_131_104_397_375_402"

},

{

"faceFileId": "13579246807",

"faceCoordinates": "54_62_190_65_52_198_180_201"

}

],

"issued":"2013-08-01T00:00:00+09:00",

"modified": "2013-08-09T12:00:00+09:00"

}

https://cocoa.ntt.com/rest/recognition/v1/face/100000


100

5.22. 人物変更 API

変更する人物 ID と変更後の人物情報（人物名、人物を表すファイル ID、顔位置情報）を指定して、

人物情報を変更します。

リクエスト URI


https://cocoa.ntt.com/rest/recognition/v1/face/{faceId}


1 faceId string ◯

変更する人物 ID


半角数字









1 faceName string

変更する人物名(※1)



登録済みの人物名はエラー

EEE

2

faceFileCoordina

teList array

変更する人物を表すファイル ID と顔位置情

報のリスト

1 faceFileId string 人物を表すファイル ID 12345678907


101

2 faceCoordina

tes string

顔位置情報





109_126_380_131_

104_397_375_402

3 passphraseSetup string

変更する人物に設定するパスフレーズ設定

モード

0：設定されているパスフレーズを削除

1：パスフレーズを新規発行

0指定時にパスフレーズが設定されていない

場合、1 指定時にパスフレーズが設定されて

いる場合はエラー

1








変更した人物名 (※1)


ンマを除く)

AAA

2

faceFileCoordinat

eList array ◯

変更した人物を表すファイル ID と顔位置情

報のリスト

ファイルがない場合は null を返却

1 faceFileId string


半角数字


12345678907

2 faceCoordinat

es string

顔位置情報






109_126_380_131_

104_397_375_402


102

3 passphrase string 人物に設定されているパスフレーズ

全角ひらがな 6 文字あかさたな

4 password string

人物に設定されているパスフレーズに対応

するパスワード

全角ひらがな 6 文字

いきしちに

5 modified string ◯ 変更した人物の更新日時


2013-08-09T12:00:

00+09:00




PUT https://cocoa.ntt.com/rest/recognition/v1/face/100000




Content-Length:52

正常に変更ができる場合、passphraseSetup指定なしの場合

{

"faceName":"EEE",




]

}

変更した結果、人物を表すファイル ID と顔位置情報が削除される場合

{

"faceName":"EEE",


{ "faceFileId": "", "faceCoordinates": ""}

]

}

変更した結果、人物名のみ変更される場合①

{

"faceName":"EEE"

}

変更した結果、人物名のみ変更される場合②③④

{

"faceName":"EEE",

"faceFileCoordinateList": "" または "faceFileCoordinateList":[] または "faceFileCoordinateList":[{}]

}


103


HTTP/1.1 200 OK



パスフレーズが設定されていない状態で passphraseSetup 指定なしの場合

{

"faceName":"EEE",




],

"modified":"2013-08-19T11:00:00+09:00"

}


パスフレーズが設定されている状態で passphraseSetup指定なしの場合

{

"faceName":"EEE",




],



"modified":"2013-08-19T11:00:00+09:00"

}

正常に変更ができる場合、passphraseSetup=0の場合

{

"faceName":"EEE",




],


}

正常に変更ができる場合、passphraseSetup=1の場合

{

"faceName":"EEE",




],


}


104

5.23. 人物削除 API

削除する人物 ID を指定して、人物情報を削除します。

削除する人物 ID のみの人物グループは人物グループも削除します。

リクエスト URI

HTTP メソッド：DELETE文字コード：UTF-8

https://cocoa.ntt.com/rest/storage/v1/face/{faceId}


1 faceId string ◯ 削除する人物 ID

半角数字 100002



1 1 Authorization string ◯ 「1.2 トークン認証」参照

2 2 X-Authorization string ◯ 「1.2 トークン認証」参照







DELETE https://cocoa.ntt.com/rest/storage/v1/face/100002




HTTP/1.1 200 OK



105

5.24. 人物グループ一覧取得 API

登録した人物グループ一覧（人物グループ ID、人物グループ名、人物グループ内のファイル数、

人物グループ内の人物数、人物グループに最後に追加したファイル ID）を取得します。

リクエスト URI


https://cocoa.ntt.com/rest/recognition/v1/facegroup?reload={reload}


1 reload string



取得



on










106



1

faceGroupList array ○ 取得した人物グループの一覧

人物グループ名の辞書順

1 faceGroupId string ◯ 取得した人物グループ ID

半角数字 100

2 faceGroupName string ◯

取得した人物グループ名 (※1)


ンマを除く)

AAA

3 count string ◯ 取得した人物グループ ID に紐付くファイル

枚数 8

4 faceCount string ◯ 取得した人物グループ ID に紐付く人物数

半角数字 2

5 lastAddFileId string ◯

取得した人物グループ ID に最後に追加した

ファイル ID

半角文字

取得した人物グループ ID に紐付くファイル

がない場合は空値を返却

12345678907

6 issued string ◯ 取得した人物グループの作成日時


2014-08-17T11:00:

00+09:00

7 modified string ◯ 取得した人物グループの更新日時


2014-08-19T11:00:

00+09:00




GET https://cocoa.ntt.com/rest/recognition/v1/facegroup






107


HTTP/1.1 200 OK


{

"faceGroupList": [

{

"faceGroupId" : "1",

"faceGroupName" : "家族",

"count" : "20",

"faceCount" : "4",

"lastAddFileId" : "123",

"issued" : "2014-08-09T11:00:00+09:00",

"modified" : "2014-08-19T11:00:00+09:00"

},

{


"faceGroupName" : "会社",

"count" : "50",

"faceCount" : "30",

"lastAddFileId" : "1234",

"issued" : "2014-08-15T11:00:00+09:00",

"modified" : "2014-08-16T11:00:00+09:00"

},

]

}

人物グループ内のフォト枚数が 0枚の場合

{

"faceGroupList": [

{


"faceGroupName" : "家族",

"count" : "0",

"faceCount" : "4",

"issued" : "2014-08-09T11:00:00+09:00",

"modified" : "2014-08-19T11:00:00+09:00"

},

]

}

人物グループ一覧が存在しない場合

{

"faceGroupList": null

}


108

5.25. 人物グループ追加 API

追加する人物グループ情報（人物グループ名、人物グループに属する人物 ID）を指定して、人物グループ

を追加します。

リクエスト URI


https://cocoa.ntt.com/rest/recognition/v1/facegroup









1 faceGroupName string ◯ 追加する人物グループ名(※1)

全半角文字(半角カタカナを除く) 家族

2 faceIds array ◯

追加する人物 ID リスト


複数指定可能

100123






109



1 faceGroupId string ◯ 追加した人物グループ ID

半角数字 100123

2 faceGroupeName string ◯ 追加した人物グループ名 (※1)


3 faceIds array ◯

追加した人物 ID リスト


複数存在する場合は(,)区切りで出力

["1","2","3"]

4 issued string ◯ 追加した人物グループ ID の作成日時


2013-08-01T00:00:

00+09:00





POST https://cocoa.ntt.com/rest/recognition/v1/facegroup




{

"faceGroupName": "家族",

"faceIds":["100001","100012","100123"]

}



{

"faceGroupId": "1234",


"faceIds": ["100001","100123"],

"issued": "2014-08-17T11:00:00+09:00"

}



110

5.26. 人物グループ取得 API

取得する人物グループ IDを指定して、人物グループ情報（人物グループ名、人物 ID、人物名）を取得します。

リクエスト URI


https://cocoa.ntt.com/rest/recognition/v1/facegroup/{facegroupId}?reload={relo

ad}


1 faceGroupId string ◯

取得する人物グループ ID


半角数字

100

2 reload string



取得



on











1 faceGroupName string ◯ 取得した人物グループ名 (※1)



111

2

faceList array ◯ 取得した人物グループの人物リスト

1 faceId string ◯ 人物 ID 100123


人物名



田中二郎

3 issued string ◯ 人物グループの作成日時


2013-08-01T00:00:

00+09:00

4 modified string ◯ 人物グループの最終更新日時


2013-08-09T12:00:

00+09:00





GET https://cocoa.ntt.com/rest/recognition/v1/facegroup/100




HTTP/1.1 200 OK


{


"faceList": [

{

"faceId": "101234",

"faceName": "田中一郎"

},

{

"faceId": "112345",

"faceName": "田中二郎"

}

],

"issued": "2014-08-17T11:00:00+09:00",

"modified" : "2014-08-19T11:00:00+09:00"

}

https://cocoa.ntt.com/rest/recognition/v1/facegroup/100


112

5.27. 人物グループ変更 API

変更する人物グループ ID と変更後の人物グループ情報（人物グループ名、人物 ID）を指定して、

人物グループ情報を変更します。

リクエスト URI


https://cocoa.ntt.com/rest/recognition/v1/facegroup/{faceGroupId}


1 faceGroupId string ◯ 変更する人物グループ ID

半角数字 123









1 1 faceGroupName string (※1) 変更する人物グループ名

全半角文字(半角カナを除く) 家族

2 faceIds array (※1)

変更する人物 ID リスト


複数指定可能

100123

※1 変更する人物グループ名、変更する人物 ID リストのいずれかは必須。未指定の場合、エラー






113



1 faceGroupName string ◯ 変更した人物グループ名家族

2 faceIds array ◯

変更した人物 ID リスト


複数存在する場合は(,)区切りで出力

["100001","100012

","100123","10123

4"]

3 modified string ◯ 変更した人物グループの更新日

yyyy-MM-dd'T'HH:mm:ss+09:00 (※1)

2014-08-19T11:00:

00+09:00




PUT https://cocoa.ntt.com/rest/recognition/v1/facegroup/123




人物グループ名と人物 IDを変更する場合

{


"faceIds":["100001","100012","100123","101234"]

}

人物グループ名のみを変更する場合

{

"faceGroupName": "家族"

}

人物 IDのみを変更する場合

{

"faceIds":["100001","100012","100123","101234"]

}

HTTP/1.1 200 OK


{


"faceIds": ["100001","100012","100123","101234"],

"modified": "2014-08-19T11:00:00+09:00"

}


114

5.28. 人物グループ削除 API

削除する人物グループ IDを指定して、人物グループを削除します。

リクエスト URI

HTTP メソッド：DELETE 文字コード：UTF-8

https://cocoa.ntt.com/rest/recognition/v1/facegroup/{faceGroupId}


1 faceGroupId string ◯ 削除する人物グループ ID

半角数字 123











DELETE https://cocoa.ntt.com/rest/recognition/v1/facegroup/123




HTTP/1.1 200 OK



マイポケット api リファレンス...copyright © 2016 ntt communications 5 sort5 string...

Documents