機械翻訳について

ジャンプ先

• 要求
• レスポンス
• 例

アプリケーション・プロビジョニングの検索

get

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

指定したアプリケーションのプロビジョニング情報を検索します。

要求

パス・パラメータ

• app: string

  アプリケーション名

問合せパラメータ

• filter(optional): string

  入力には、all、groupまたはuserが含まれます。 デフォルト値はallであるため、この問合せパラメータが指定されていない場合は、すべてのユーザーおよびグループが返されます。

  デフォルト値: all
• id(optional): string

  ユーザーまたはグループIDのワイルドカード・パターン。指定した場合、パターンに一致するユーザーおよびグループを返します。 指定しない場合、ロールを持つすべてのユーザーおよびグループが返されます。 ロールを持たないユーザーまたはグループは返されません。

  デフォルト値: *
• inherited(optional): boolean

  trueの場合、親グループを介して導出されたロールを考慮します。 デフォルトはfalseです。

  デフォルト値: false
• role(optional): string

  入力には、all、noneまたはカンマ区切りのロール・リスト(app_manager, db_manager, db_update、db_accessなど)を含めることができます。 デフォルト値はallであるため、この問合せパラメータを指定しない場合、なんらかのロールを持つすべてのユーザーおよびグループが返されます。 noneが指定されている場合、ロールを持たないユーザーおよびグループのみが返されます。 名前付きロールが指定されている場合は、名前付きロールのいずれかを持つユーザーおよびグループのみが返されます。

  デフォルト値: all

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

検索基準に一致するユーザーまたはグループのプロビジョニング情報が正常に返されました。 レスポンス・タイプは、Acceptヘッダーに応じてJSON、XMLまたはCSVストリームのいずれかになります。 Accept='application/json'またはAccept='application/xml'の場合、検索結果はレスポンス本文に返されます。 Accept='application/octet-stream'の場合、検索結果はストリームとして返されます。

本文()

ルート・スキーマ : result

タイプ: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  許可される追加プロパティ: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserGroupProvisionInfo"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"result"
    }
}

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

タイプ: array

Show Source

• Array of: object permission

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

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

タイプ: object

許可される追加プロパティ

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

タイプ: object

Show Source

• group(optional): boolean
• id(optional): string
• links(optional): array links
• name(optional): string
• role(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "group":{
            "type":"boolean"
        }
    },
    "xml":{
        "name":"permission"
    }
}

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

タイプ: array

Show Source

• Array of: object Link

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

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): 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://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions?id=*&role=all&filter=all&inherited=false" 
     -H  "accept: application/json"
     -u %User%:%Password%

レスポンス本体の例

{
  "items": [
    {
      "id": "User001",
      "role": "db_access",
      "links": [
        {
          "rel": "get",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User001",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User001",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User001",
          "method": "DELETE"
        }
      ]
    },
    {
      "id": "User002",
      "role": "db_update",
      "links": [
        {
          "rel": "get",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User002",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User002",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User002",
          "method": "DELETE"
        }
      ]
    },
    {
      "id": "User003",
      "role": "db_manager",
      "links": [
        {
          "rel": "get",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User003",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User003",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User003",
          "method": "DELETE"
        }
      ]
    },
    {
      "id": "User004",
      "role": "app_manager",
      "links": [
        {
          "rel": "get",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User004",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User004",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/permissions/User004",
          "method": "DELETE"
        }
      ]
    }
  ]
}

先頭に戻る