next

Cell取得

概要

既存のCell情報を取得する

必要な権限

Unitユーザのみ可能

制限事項

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

リクエスト

リクエストURL

{UnitURL}__ctl/Cell(Name='{CellName}')

または、

{UnitURL}__ctl/Cell('{CellName}')

メソッド

GET

リクエストクエリ

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

$select クエリ

$expand クエリ

$format クエリ

リクエストヘッダ

共通リクエストヘッダ

ヘッダ名概要有効値必須備考
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取得リクエストヘッダ

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

リクエストボディ

なし

リクエストサンプル

なし

レスポンス

ステータスコード

200

レスポンスヘッダ

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

レスポンスボディ

共通レスポンスボディ

レスポンスはJSONオブジェクトで、オブジェクト（サブオブジェクト）に定義される

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

Cell固有レスポンスボディ

オブジェクト名前（キー）型値
{3}typestringUnitCtl.Cell
{2}NamestringCellの名称

エラーメッセージ一覧

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

レスポンスサンプル

{
  "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('cell1')" -X GET -i -H \
'Authorization: Bearer PEFzc2V...(省略)...lvbj4' -H 'Accept: application/json'
← Cell作成Cell一覧取得 →