next

AssociationEnd登録

概要

ユーザデータのAssociationEndを登録する

必要な権限

alter-schema

制限事項

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

リクエスト

リクエストURL

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

メソッド

POST

リクエストクエリ

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

リクエストヘッダ

共通リクエストヘッダ

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

OData共通リクエストヘッダ

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

OData登録リクエストヘッダ

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

リクエストボディ

Format

JSON

項目名概要有効値必須備考
NameAssociation名桁数：1～128
文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー)
ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可		○
Multiplicity多重度"0 .. 1" / "1" / "*"○
_EntityType.Name関係対象のEntityType名桁数：1～128
文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー)
ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可
説明：EntityType登録APIにて登録済みのEntityType		○

リクエストサンプル

{
   "Name": "association-end1",
  "Multiplicity": "1",
  "_EntityType.Name": "entity-type1"  
}

レスポンス

ステータスコード

201

レスポンスヘッダ

共通レスポンスヘッダ

ヘッダ名概要備考
Access-Control-Allow-Originクロスドメイン通信許可ヘッダ返却値は"*"固定
X-Personium-VersionAPIの実行バージョンリクエストが処理されたAPIバージョン

ODataレスポンスヘッダ

ヘッダ名概要備考
Content-Type返却されるデータの形式
Location作成したリソースへのURL
DataServiceVersionODataのバージョン
ETagリソースのバージョン情報

レスポンスボディ

共通レスポンスボディ

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

オブジェクト名前（キー）型値
ルートdobjectオブジェクト{1}
{1}resultsarrayオブジェクト{2}の配列
{2}__metadataobjectオブジェクト{3}
{3}uristring作成したリソースへのURL
{3}etagstringEtag値
{2}__publishedstring作成日(UNIX時間)
{2}__updatedstring更新日(UNIX時間)
{1}__countstring$inlinecountクエリでの取得結果件数

AssociationEnd個別レスポンスボディ

オブジェクト名前（キー）型値
{3}typestringODataSvcSchema.AssociationEnd
{2}NamestringAssociationEnd名
{2}Multiplicitystring多重度
{2}_EntityType.Namestring関係対象のEntityType名

レスポンスサンプル

{
  "d": {
    "results": {
      "__metadata": {
        "uri": "https://cell1.unit1.example/box1/odata-collection1/$metadata
/AssociationEnd(Name='association-end1',_EntityType.Name='entity-type1')",
        "etag": "W/\"1-1487652733383\"",
        "type": "ODataSvcSchema.AssociationEnd"
      },
      "Name": "association-end1",
      "Multiplicity": "1",
      "_EntityType.Name": "entity-type1",
      "__published": "/Date(1487652733383)/",
      "__updated": "/Date(1487652733383)/"
    }
  }
}

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/box1/odata-collection1/\$metadata/AssociationEnd" -X POST -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '{ "Name": "association-end1", "Multiplicity": "1", "_EntityType.Name": "entity-type1"}'
← Property削除AssociationEnd取得 →