1.7.21

Property登録

概要

ユーザデータに指定するプロパティを定義する

必要な権限

alter-schema

制限事項

  • OData制限
    • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
    • リクエストボディはJSON形式のみ受け付ける
    • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
    • $formatクエリオプションにatom または xmlを指定した場合、エラーとはならないが、レスポンスボディのデータの保証はない
  • 個別の制限
    • 関連対象のEntityTypeを使用したユーザデータが存在する場合は、Nullableがtrueの場合のみ登録可能
    • Edm.DateTime型の配列は使用不可
    • Edm.DateTimeのDefaultValueの有効範囲のチェックが適切に行われない
    • 1つのEntityTypeに対して作成出来るのは、DynamicProperty・DeclaredProperty・ComplexTypeProperty合わせて400個まで
    • isKey/UniqueKeyを設定しても、スキーマへの反映はされない

リクエスト

リクエストURL

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

メソッド

POST

リクエストクエリ

共通リクエストクエリ

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

OData 共通リクエストクエリ

なし

リクエストヘッダ

共通リクエストヘッダ

ヘッダ名概要有効値必須備考
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

項目名概要有効値必須備考
NameProperty名桁数：1～128
文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー)
ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可		○
_EntityType.Name紐付くEntityType名桁数：1～128
文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー)
ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可		○
Type型定義Edm.Boolean / Edm.String / Edm.Int32 / Edm.Single / Edm.Double / Edm.DateTime / 登録済みComplexType名○
Nullablenull値許可true / false
デフォルト値は true		×
DefaultValueデフォルト値Refer to the following table
デフォルト値は null		×
CollectionKind配列種別None / List
デフォルト値は "None"		×
IsKey主キー設定true / false
デフォルト値は false		×
UniqueKeyユニークキー設定桁数：1～128
文字種:半角英数字と-(半角ハイフン)と(半角アンダーバー)
ただし、先頭文字に-(半角ハイフン)と(半角アンダーバー)は指定不可		×

Valid values for DefaultValue

DefaultValueの有効値はTypeの値（型定義）によって異なり、以下の定義となる型の異なる項目についても文字列で定義を行う

type値有効値
Edm.Booleantrue / false
Edm.String桁数：0～51200 byte
「\」を使用する場合、「\\」で指定する必要がある
Edm.Int32-2147483648 ～ 2147483647
Edm.Single整数部分の桁数：1～5桁
小数部分の桁数：1～5桁
Edm.Double15 桁の有効桁数を持つ浮動小数点数を表します。
Edm.DateTime/Date(【long型の時刻】)/の形式で文字列で指定する
　【long型の時刻】の有効値は、-6847804800000(1753-01-01T00:00:00.000Z)～253402300799999(9999-12-31T23:59:59.999Z)
また、予約語として以下を指定可能
　SYSUTCDATETIME()：サーバ時間

リクエストサンプル

{
   "Name": "property1",
  "_EntityType.Name": "entity-type1",
  "Type": "Edm.String",
  "Nullable": true,
  "DefaultValue": null,
  "CollectionKind": "None",
  "IsKey": true,
  "UniqueKey": null,
}

レスポンス

ステータスコード

200

レスポンスヘッダ

共通レスポンスヘッダ

ヘッダ名概要備考
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クエリでの取得結果件数

Property固有レスポンスボディ

オブジェクト名前（キー）型値
{3}typestringODataSvcSchema.Property
{2}NamestringProperty名
{2}_EntityType.Namestring紐付くEntityType名
{2}Typestring型定義
{2}Nullablebooleannull値許可
{2}DefaultValuestringデフォルト値
{2}CollectionKindstring配列種別
{2}IsKeyboolean主キー設定
{2}UniqueKeystringユニークキー設定
{2}IsDeclaredbooleanDeclaredかの真偽

エラーメッセージ一覧

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

レスポンスサンプル

{
  "d": {
    "results": {
      "__metadata": {
        "uri": "https://cell1.unit1.example/box1/odata-collection1/$metadata/Property
(Name='property1',_EntityType.Name='entity-type1')",
        "etag": "W/\"1-1487635336196\"",
        "type": "ODataSvcSchema.Property"
      },
      "Name": "property1",
      "_EntityType.Name": "entity-type1",
      "Type": "Edm.String",
      "Nullable": true,
      "DefaultValue": null,
      "CollectionKind": "None",
      "IsKey": true,
      "UniqueKey": null,
      "IsDeclared": true,
      "__published": "/Date(1487635336196)/",
      "__updated": "/Date(1487635336196)/"
    }
  }
}

cURLサンプル

curl "https://cell1.unit1.example/box1/odata-collection1/\$metadata/Property" -X POST -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '{"Name": "property1","_EntityType.Name": "entity-type1","Type": "Edm.String","Nullable": true,\
"DefaultValue": null,"CollectionKind": "None","IsKey": true,"UniqueKey": null}'
← EntityType削除Property取得 →