ComplexTypeProperty一覧取得

概要

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

必要な権限

read

制限事項

リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
リクエストボディはJSON形式のみ受け付ける
レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
$formatクエリオプションにatom または xmlを指定した場合、エラーとはならないが、レスポンスボディのデータの保証はない

リクエスト

リクエストURL

{CellURL}{BoxName}/{ODataCollecitonName}/$metadata/ComplexTypeProperty

メソッド

GET

リクエストクエリ

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

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

リクエストヘッダ

共通リクエストヘッダ

ヘッダ名	概要	有効値	必須	備考
X-HTTP-Method-Override	メソッドオーバーライド機能	任意	×	POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用される
X-Override	ヘッダオーバライド機能	${上書きするヘッダ名}:${値}	×	通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定する
X-Personium-RequestKey	イベントログに出力するRequestKeyフィールドの値	半角英数、-(半角ハイフン)と_(半角アンダーバー) 最大128文字	×	指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番

OData共通リクエストヘッダ

ヘッダ名	概要	有効値	必須	備考
Authorization	OAuth2.0形式で、認証情報を指定する	Bearer {AccessToken}	×	※認証トークンは認証トークン取得APIで取得したトークン

OData一覧取得リクエストヘッダ

ヘッダ名	概要	有効値	必須	備考
Accept	レスポンスボディの形式を指定する	application/json	×	省略時は[application/json]として扱う

リクエストボディ

なし

レスポンス

ステータスコード

200

レスポンスヘッダ

なし

レスポンスボディ

共通レスポンスボディ

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

オブジェクト	名前（キー）	型	値
ルート	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クエリでの取得結果件数

Property固有レスポンスボディ

オブジェクト	名前（キー）	型	値
{3}	type	string	ODataSvcSchema.ComplexTypeProperty
{2}	Name	string	ComplexTypeProperty名
{2}	_ComplexType.Name	string	紐付くComplexType名
{2}	Type	string	型定義
{2}	Nullable	boolean	null値許可
{2}	DefaultValue	string	デフォルト値
{2}	CollectionKind	string	配列種別

エラーメッセージ一覧

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

レスポンスサンプル

{
  "d": {
    "results": [
      {
        "__metadata": {
          "uri": "https://cell1.unit1.example/box1/odata-collection1/$metadata
/ComplexTypeProperty(Name='complex-type-property1',_ComplexType.Name='complex-type1')",
          "etag": "W/\"1-1487587033861\"",
          "type": "ODataSvcSchema.ComplexTypeProperty"
        },
        "Name": "complex-type-property1",
        "_ComplexType.Name": "complex-type1",
        "Type": "Edm.String",
        "Nullable": true,
        "DefaultValue": null,
        "CollectionKind": "None",
        "__published": "/Date(1487587033861)/",
        "__updated": "/Date(1487587033861)/",
        "_ComplexType": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/box1/odata-collection1/$metadata
/ComplexTypeProperty(Name='complex-type-property1',_ComplexType.Name='complex-type1')
/_ComplexType"
          }
        }
      },
      {
        "__metadata": {
          "uri": "https://cell1.unit1.example/box1/odata-collection1/$metadata
/ComplexTypeProperty(Name='complex-type-property2',_ComplexType.Name='complex-type2')",
          "etag": "W/\"1-1487658277593\"",
          "type": "ODataSvcSchema.ComplexTypeProperty"
        },
        "Name": "complex-type-property2",
        "_ComplexType.Name": "complex-type2",
        "Type": "Edm.String",
        "Nullable": true,
        "DefaultValue": null,
        "CollectionKind": "None",
        "__published": "/Date(1487658277593)/",
        "__updated": "/Date(1487658277593)/",
        "_ComplexType": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/box1/odata-collection1/$metadata
/ComplexTypeProperty(Name='complex-type-property2',_ComplexType.Name='complex-type2')
/_ComplexType"
          }
        }
      }
    ]
  }
}

cURLサンプル

curl "https://cell1.unit1.example/box1/odata-collection1/\$metadata/ComplexTypeProperty" \
-X GET -i -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'