Box一覧取得 · Personium

概要

既存のBox情報の一覧を取得する

必要な権限

box-read

制限事項

リクエストヘッダのAcceptは無視される
リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
リクエストボディはJSON形式のみ受け付ける
レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
$formatクエリオプションは無視される

リクエスト

リクエストURL

{CellURL}__ctl/Box

メソッド

GET

リクエストクエリ

以下のクエリパラメタが利用可能です。

クエリ名	概要	有効値	必須	備考
p_cookie_peer	クッキー認証値	認証時にサーバから返却されたクッキー認証値	×	Authorizationヘッダの指定が無い場合のみ有効クッキーの認証情報を利用する場合に指定する

リクエストヘッダ

ヘッダ名	概要	有効値	必須	備考
X-HTTP-Method-Override	メソッドオーバーライド機能	任意	×	POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用されます。
X-Override	ヘッダオーバライド機能	${上書きするヘッダ名}:${値}override} $: $ {value}	×	通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定します。
X-Personium-RequestKey	イベントログに出力するRequestKeyフィールドの値	半角英数、-(半角ハイフン)と_(半角アンダーバー) 最大128文字	×	指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番
Authorization	OAuth2.0形式で、認証情報を指定する	Bearer {AccessToken}	×	※認証トークンは認証トークン取得APIで取得したトークン
Accept	レスポンスボディの形式を指定する	application/json	×	省略時は[application/json]として扱う

リクエストボディ

なし

レスポンス

ステータスコード

200

レスポンスヘッダ

なし

レスポンスボディ

レスポンスはJSONオブジェクトで、オブジェクト（サブオブジェクト）に定義されるキー(名前)と型、並びに値の対応は以下のとおりです。

オブジェクト	項目名	Data Type	備考
ルート	d	object	オブジェクト{1}
{1}	results	array	オブジェクト{2}の配列
{2}	__metadata	object	オブジェクト{3}
{3}	uri	string	作成したリソースへのURL
{3}	etag	string	Etag値
{2}	__published	string	作成日(UNIX時間)
{2}	__updated	string	更新日(UNIX時間)
{1}	__count	string	$inlinecountクエリでの取得結果件数

Box固有レスポンスボディ

オブジェクト	項目名	Data Type	備考
{3}	type	string	CellCtl.Box
{2}	Name	string	Box名
{2}	Schema	string	Schema名

エラーメッセージ一覧

エラーメッセージ一覧を参照

レスポンスサンプル

{
  "d": {
    "results": [
      {
        "__metadata": {
          "uri": "https://cell1.unit1.example/__ctl/Box('box1')",
          "etag": "W/\"1-1486368212581\"",
          "type": "CellCtl.Box"
        },
        "Name": "box1",
        "Schema": null,
        "__published": "/Date(1486368212581)/",
        "__updated": "/Date(1486368212581)/",
        "_Role": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box1')/_Role"
          }
        },
        "_Relation": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box1')/_Relation"
          }
        },
        "_ReceivedMessage": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box1')/_ReceivedMessage"
          }
        },
        "_SentMessage": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box1')/_SentMessage"
          }
        },
        "_Rule": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box1')/_Rule"
          }
        }
      },
      {
        "__metadata": {
          "uri": "https://cell1.unit1.example/__ctl/Box('box2')",
          "etag": "W/\"1-1486461000154\"",
          "type": "CellCtl.Box"
        },
        "Name": "box2",
        "Schema": null,
        "__published": "/Date(1486461000154)/",
        "__updated": "/Date(1486461000154)/",
        "_Role": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box2')/_Role"
          }
        },
        "_Relation": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box2')/_Relation"
          }
        },
        "_ReceivedMessage": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box2')/_ReceivedMessage"
          }
        },
        "_SentMessage": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box2')/_SentMessage"
          }
        },
        "_Rule": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Box('box2')/_Rule"
          }
        }
      }
    ]
  }
}

cURLサンプル

curl "https://cell1.unit1.example/__ctl/Box" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'