5. マイポケット API
5.12. タグ一覧取得 API
登録したタグ(※)一覧（タグID、タグ）を取得します。
※タグとは、ファイルを分類するための短い単語やフレーズです。フォルダのような階層構造を持たないの でより柔軟な分類が可能です。
※マイポケットのUIでは、タグをラベルという名称で利用しております。
リクエスト URI
HTTP
メソッド： GET 文字コード： UTF-8
https://cocoa.ntt.com/rest/storage/v1/tags?reload={reload}
No キー 型 必須 説明 サンプル値
1 page string 取得するページ番号
0~7byte、半角数字(1～9999999) キー未指定時、空値指定時は「1」
対象がないページを指定してもエラーとしない 1
2 showlimit string 取得する1ページの表示件数
0~3byte、半角数字(1～200)
キー未指定、空値指定時は全件表示として処理 する。
100
3 sort string 取得する一覧のソート順を指定
1：タグ名(昇順) 2：タグ名(降順) 3：作成日時(昇順) 4：作成日時(降順)
0
4 reload string
最新情報取得フラグ
・off：キャッシュを利用、ない場合は最新情報を 取得
・on：最新情報を取得
キー未指定時、空値指定時は「off」
on
リクエストヘッダ
No キー 型 必須 説明 サンプル値
1 Authorization string ◯ 「1.2 トークン認証」参照
2 X-Authorization string ◯ 「1.2 トークン認証」参照
3 Content-Type string ◯ 「application/json」を指定
77
レスポンスヘッダ
No キー 型 必須 説明 サンプル値
1 Content-Type string ◯ コンテンツタイプ application/json
レスポンスボディ
No キー 型 必須 説明 サンプル値
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 ◯ 取得したタグの作成日時
yyyy-MM-dd'T'HH:mm:ss+09:00 形式 (※2)
2013-01-01T00:0 0:00+09:00
9 modified string ◯ 取得したタグの更新日時
yyyy-MM-dd'T'HH:mm:ss+09:00 形式 (※2)
2013-01-02T00:0 0:00+09:00 2 page
string ○ 取得したページ番号
半角数字(1以上の整数) 1 3 showlimit
string 1ページあたりの取得件数
半角数字(1以上の整数) 100
4 totalCount
string ○ 検索該当件数
半角数字(0以上の整数) 10
※ 1 バックスラッシュエスケープシーケンスを行う。
※ 2
[ISO-8601]に準拠した日付の形式78
リクエストサンプル
レスポンスサンプル
HTTP/1.1 200 OK
Content-Type: application/json
タグ情報が存在する場合 {
"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 Authorization: Bearer accesstoken
X-Authorization: AccessKey=”accesskey”
Content-Type:application/json
79