移動先

• リクエスト
• レスポンス
• 例

アプリケーション役割プロビジョニングの取得

get

/essbase/rest/v1/applications/{app}/permissions/{id}

指定されたアプリケーションについてプロビジョニング情報を取得します。

EPM共有サービス・セキュリティ・モードを使用している場合、この操作は実行できません。かわりに、共有サービス・コンソールでユーザー、グループおよび権限を管理します。

リクエスト

パス・パラメータ

• app(required): string

  アプリケーション名。

• id(required): string

  ユーザーIDまたはグループID

問合せパラメータ

• group: boolean

  trueの場合、IDはグループのIDとなります。falseの場合、IDはユーザーのIDとなります。デフォルトはfalseです(IDはユーザーのIDと見なされる。)

  デフォルト値: false
• inherited: boolean

  trueの場合は、親グループから派生した役割が考慮に入れられます。デフォルトはfalseです。

  デフォルト値: false

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json
• application/xml

200 レスポンス

OK

プロビジョニング情報が正常に返されました。

本体()

ルート・スキーマ : permission

型: object

ソースの表示

• group: boolean

  trueまたはfalse。idがグループを参照するかどうか。

• id: string

  ユーザーIDまたはグループID

• links: array links
• name: string

  ユーザー名またはグループ名。

• role: string

  ユーザーまたはグループの役割。

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"<p>User or group ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>User or group name.</p>"
        },
        "role":{
            "type":"string",
            "description":"<p>User or group role.</p>"
        },
        "group":{
            "type":"boolean",
            "description":"<p><b>true</b> or <b>false</b>. Whether the <b>id</b> refers to a group.</p>"
        }
    },
    "xml":{
        "name":"permission"
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : Link

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 レスポンス

不正なリクエスト

ログインしているユーザーに、適切なアプリケーション役割がない可能性があります。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、cURLでWindowsのシェル・スクリプトからREST APIを呼び出してアプリケーションのプロビジョニング詳細を取得する方法を示します。

呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002?group=false&inherited=true"-H  "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "id": "User002",
  "role": "db_update",
  "links": [
    {
      "rel": "get",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "GET"
    },
    {
      "rel": "edit",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "PUT"
    },
    {
      "rel": "delete",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "DELETE"
    }
  ]
}

先頭に戻る