1. Oracle EssbaseのREST API
  2. タスク
  3. ユーザー

ユーザーの検索またはエクスポート

get

/essbase/rest/v1/users

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

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

リクエスト

問合せパラメータ

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

    デフォルト値: all

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

  • ヘッダーがAccept='application/json'またはAccept='application/xml'である場合は、返される最大ユーザー数。デフォルト値-1の場合、最大数は設定されません。

    デフォルト値: -1
先頭に戻る

レスポンス

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

200 レスポンス

OK

ユーザーの結果が正常に返されました。レスポンス・タイプは、Acceptヘッダーに応じてJSON、XMLまたはCSVストリームのいずれかになります。Accept='application/json'またはAccept='application/xml'である場合は、ユーザーがレスポンス本体で返されます。Accept=application/octet-streamである場合は、ユーザーがJSONストリームとして返されます。

本体()
ルート・スキーマ : Users
型: object
ソースの表示
ネストされたスキーマ : items
型: array
ソースの表示
ネストされたスキーマ : properties
型: object
使用可能なその他のプロパティ
ソースの表示
ネストされたスキーマ : User
型: object
ソースの表示
  • groups

    このユーザーに関連付けられているグループ名のカンマ区切りリスト。

  • ユーザーID。

  • links

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

  • ユーザーのパスワード。

  • ユーザーの役割。有効な役割は、ユーザー、パワー・ユーザーおよびサービス管理者です。

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

このユーザーに関連付けられているグループ名のカンマ区切りリスト。

ソースの表示

400 レスポンス

不正なリクエスト

ログインしているユーザーに、適切なサービス役割がない可能性があります。

500 レスポンス

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

先頭に戻る

例

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

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

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

次の例では、最大5人のユーザーを表示します。

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

レスポンス本体の例

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

{
  "items": [
    {
      "id": "User001",
      "name": "User One",
      "email": "user001@example.com"
    },
    {
      "id": "User002",
      "name": "User Two",
      "email": "user002@example.com"
    },
    {
      "id": "User003",
      "name": "User Three",
      "email": "user003@example.com"
    },
    {
      "id": "User004",
      "name": "User Four",
      "email": "user004@example.com"
    },
    {
      "id": "User005",
      "name": "User Five",
      "email": "user005@example.com"
    }
  ]
}

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

次の例では、ユーザーをusers.csvにエクスポートします。 

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