Cell作成 · Personium

概要

新規Cellを作成する

必要な権限

Unitユーザのみ可能

制限事項

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

リクエスト

リクエストURL

{UnitURL}__ctl/Cell

メソッド

POST

リクエストクエリ

クエリは無視する

リクエストヘッダ

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

リクエストボディ

Format

JSON

項目名	概要	有効値	必須	備考
Name	Cell名	桁数：1～128 文字種:半角英小文字と半角数字と-(半角ハイフン) ただし、先頭文字に-(半角ハイフン)は指定不可	○

リクエストサンプル

{"Name":"cell1"}

レスポンス

ステータスコード

201

レスポンスヘッダ

ヘッダ名	概要	備考
Content-Type	返却されるデータの形式
Location	作成したリソースへのURL
DataServiceVersion	ODataのバージョン
ETag	リソースのバージョン情報
Access-Control-Allow-Origin	クロスドメイン通信許可ヘッダ	返却値は"*"固定
X-Personium-Version	Personium APIの実行バージョン	リクエストが処理されたAPIバージョン

レスポンスボディ

共通レスポンスボディ

レスポンスは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クエリでの取得結果件数

個別レスポンスボディ

オブジェクト	名前（キー）	型	値
{3}	type	string	UnitCtl.Cell
{2}	Name	string	Cellの名称

エラーメッセージ一覧

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

レスポンスサンプル

{
  "d": {
    "results": {
      "__metadata": {
        "uri": "https://unit1.example/__ctl/Cell(Name='cell1')",
        "etag": "W/\"1-1486427790039\"",
        "type": "UnitCtl.Cell"
      },
      "Name": "cell1",
      "__published": "/Date(1486427790039)/",
      "__updated": "/Date(1486427790039)/"
    }
  }
}

cURLサンプル

curl "https://unit1.example/__ctl/Cell" -X POST -i \
-H 'Authorization: Bearer PEFzc2V...(省略)...lvbj4' \
-H 'Accept: application/json' -d '{"Name":"cell1"}'