next

Role取得

概要

既存のRole情報を取得する

必要な権限

auth-read

制限事項

  • OData 制限
    • リクエストヘッダのAcceptは無視される
    • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
    • リクエストボディはJSON形式のみ受け付ける
    • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
    • $formatクエリオプションは無視される

リクエスト

リクエストURL

{CellURL}__ctl/Role(Name='{RoleName}',_Box.Name='{BoxName}')

または、

{CellURL}__ctl/Role(Name='{RoleName}')

または、

{CellURL}__ctl/Role('{RoleName}')

※ _Box.Nameパラメタを省略した場合は、nullが指定されたものとする

メソッド

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登録リクエストヘッダ

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

リクエストボディ

なし

レスポンス

ステータスコード

200

レスポンスヘッダ

なし

レスポンスボディ

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

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

Role固有レスポンスボディ

オブジェクト項目名型備考
{3}typestringCellCtl.Role
{2}NamestringRole名
{2}_Box.Namestring関係対象のBox名

エラーメッセージ一覧

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

レスポンスサンプル

{
  "d": {
    "results": {
      "__metadata": {
        "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')",
        "etag": "W/\"1-1486349783744\"",
        "type": "CellCtl.Role"
      },
      "Name": "role1",
      "_Box.Name": "box1",
      "__published": "/Date(1486349783744)/",
      "__updated": "/Date(1486349783744)/",
      "_Box": {
        "__deferred": {
          "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')
/_Box"
        }
      },
      "_Account": {
        "__deferred": {
          "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')
/_Account"
        }
      },
      "_ExtCell": {
        "__deferred": {
          "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')
/_ExtCell"
        }
      },
      "_ExtRole": {
        "__deferred": {
          "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')
/_ExtRole"
        }
      },
      "_Relation": {
        "__deferred": {
          "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')
/_Relation"
        }
      }
    }
  }
}

cURLサンプル

curl "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')" -X GET \
-i -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json'
← Role登録Role一覧取得 →