移動先

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

アプリケーションのプロビジョニング・レポートの取得

get

/essbase/rest/v1/groups/{groupId}/provisionReport/applications/{application}

指定されたアプリケーションについてプロビジョニング・レポートを取得します。ログイン・ユーザーに、少なくとも、そのアプリケーションのデータベース・マネージャ役割が必要となります。アプリケーション役割は、ログイン・ユーザーに少なくともそのアプリケーションのアプリケーション・マネージャ役割がある場合のみ、レポートに含まれます。

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

リクエスト

パス・パラメータ

• application(required): string

  アプリケーション名。

• groupId(required): string

  グループID。

問合せパラメータ

• expand: string

  指定できる値はallまたはnoneです。デフォルト値はnoneです。値がnoneである場合は、役割、フィルタおよびスクリプトへのリンクのみが返されます。値がallである場合は、役割、フィルタおよびスクリプトのプロビジョニング情報が返されます。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

プロビジョニング・レポートが正常に返されました。

本体()

ルート・スキーマ : ApplicationProvisionReportItem

型: object

ソースの表示

• filters: object DatabaseProvisionReportItemList
• name: string
• roles: object ProvisionReportItemList
• scripts: object DatabaseProvisionReportItemList

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "roles":{
            "$ref":"#/definitions/ProvisionReportItemList"
        },
        "filters":{
            "$ref":"#/definitions/DatabaseProvisionReportItemList"
        },
        "scripts":{
            "$ref":"#/definitions/DatabaseProvisionReportItemList"
        }
    }
}

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

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• links: array links
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DatabaseProvisionReportItem"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• links: array links
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProvisionReportItem"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: array

ソースの表示

• 配列: object DatabaseProvisionReportItem

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

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

型: array

ソースの表示

• 配列: object Link

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

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

型: object

使用可能なその他のプロパティ

ソースの表示

• string

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

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

型: object

ソースの表示

• database: string
• items: array items

{
    "type":"object",
    "properties":{
        "database":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProvisionReportItem"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object ProvisionReportItem

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

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

型: object

ソースの表示

• inheritedFromGroups: array inheritedFromGroups
  一意のアイテムが必要: true
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "inheritedFromGroups":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

一意のアイテムが必要: true

ソースの表示

• 配列: string

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : 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"
        }
    }
}

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

型: array

ソースの表示

• 配列: object ProvisionReportItem

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

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

型: array

ソースの表示

• 配列: object Link

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

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

型: object

使用可能なその他のプロパティ

ソースの表示

• string

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

400 レスポンス

不正なリクエスト

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

404 レスポンス

見つかりません

そのIDのグループが存在しません。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseサーバー上の1つのアプリケーションへの特定のグループのアクセスに関するレポートへのリンクを取得する方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

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

このスクリプトは、アプリケーションSampleに関連するグループID dbaccessgroupのプロビジョニング情報をリクエストします。

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/groups/dbaccessgroup/provisionReport/applications/Sample -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "name" : "Sample",
  "roles" : {
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/dbaccessgroup/provisionReport/applications/Sample/roles",
      "method" : "GET"
    } ]
  },
  "filters" : {
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/dbaccessgroup/provisionReport/applications/Sample/filters",
      "method" : "GET"
    } ]
  },
  "scripts" : {
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/dbaccessgroup/provisionReport/applications/Sample/scripts",
      "method" : "GET"
    } ]
  }
}

先頭に戻る