移動先

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

グループの検索またはエクスポート

get

/essbase/rest/v1/groups

検索結果に基づいてグループのリストを取得するか、グループをCSVファイルとしてエクスポートします。

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

リクエスト

問合せパラメータ

• expand: string

  指定できる値はallまたはnoneです。デフォルト値はallです。この場合は、サービス役割と親グループがグループごとに返されます。noneを指定した場合、サービス役割と親グループは返されません。

  デフォルト値: all
• filter: string

  グループIDのワイルドカード・パターン。ヘッダーがAccept='application/json'またはAccept='application/xml'である場合は、グループの名前を基準にフィルタします。

• limit: integer(int32)

  ヘッダーがAccept='application/json'またはAccept='application/xml'である場合は、返される最大グループ数。

  デフォルト値: -1

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

検索条件に一致するグループのリスト。レスポンス・タイプは、Acceptヘッダーに応じてJSON、XMLまたはCSVストリームのいずれかになります。Accept='application/json'またはAccept='application/xml'である場合は、レスポンスで検索結果が返されます。Accept='application/octet-stream'である場合、検索結果はストリームとして返されます(Swaggerの制限事項により表示されない)。

本体()

ルート・スキーマ : Groups

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: 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/GroupBean"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object GroupBean

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

• description: string
• groups: array groups
• links: array links
• name: string

  グループ名。256文字以内で入力してください。特殊文字; , = + * ? [ ] | < > \ " ' / スペース タブは使用できません。また、ピリオド(.)はグループ名で使用できません。

• role: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "description":{
            "type":"string"
        },
        "groups":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "role":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"<p>The group name. Limit 256 characters. The following special characters are not permitted: <code>; , = + * ? [ ] | < > \\ \" ' / Space Tab</code>. Additionally, a period (<code>.</code>) is not permitted in group names.</p>"
        }
    }
}

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

型: array

ソースの表示

• 配列: string

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

ネストされたスキーマ : 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 レスポンス

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

先頭に戻る

例

次の例では、Essbaseグループをリストまたはエクスポートする方法を示します。

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

cURLコマンドを含むスクリプト – グループのリスト

call properties.bat
curl -X GET -u %User%:%Password% "https://myserver.example.com:9001/essbase/rest/v1/groups?filter=*&links=none" -H "accept: application/json"

レスポンス本体の例

次の例では、レスポンス本体の内容をJSON形式で示します。

{
  "items" : [ {
    "name" : "appmanagers"
  }, {
    "name" : "dbmanagers"
  }, {
    "name" : "FilterGroup"
  }, {
    "name" : "powergroup"
  } ]
}

cURLコマンドを含むスクリプト – グループのエクスポート

次の例では、グループをgroups.csvにエクスポートします。

call properties.bat
curl -X GET -u %User%:%Password% "https://myserver.example.com:9001/essbase/rest/v1/groups?filter=*" -H "Accept: application/octet-stream" -o groups.csv

先頭に戻る