機械翻訳について
  1. Oracle EssbaseのREST API
  2. タスク
  3. ユーザー

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

get

/essbase/rest/v1/users

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

要求

問合せパラメータ

  • 値は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
Show Source
ネストされたスキーマ : items
タイプ: array
Show Source
ネストされたスキーマ : properties
タイプ: object
許可される追加プロパティ
Show Source
ネストされたスキーマ : User
タイプ: object
Show Source
ネストされたスキーマ : groups
タイプ: array

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

Show Source

400 レスポンス

不正なリクエスト

ログイン・ユーザーが適切なサービス・ロールを持っていない可能性があります。

500 レスポンス

内部サーバー・エラー。

先頭に戻る

例

次の例では、cURLを使用してWindowsシェル・スクリプトからREST APIにアクセスし、Essbaseユーザーのリストを取得する方法を示します。

コール元のユーザーIDおよびパスワードは、properties.batで値が設定される変数です。

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

call properties.bat

curl -X GET "https://192.0.2.1:443/essbase/rest/v1/users?filter=User00*&limit=5&expand=none" 
     -H  "accept: application/json"
     -u %User%:%Password%

レスポンス本体の例

JSON形式のレスポンス本文のコンテンツの例を次に示します:

{
  "items": [
    {
      "id": "User001",
      "name": "User One",
      "email": "user001@example.com",
      "links": [
        {
          "rel": "get",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User001",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User001",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User001",
          "method": "DELETE"
        },
        {
          "rel": "provisionReport",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User001/provisionReport",
          "method": "GET"
        }
      ]
    },
    {
      "id": "User002",
      "name": "User Two",
      "email": "user002@example.com",
      "links": [
        {
          "rel": "get",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User002",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User002",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User002",
          "method": "DELETE"
        },
        {
          "rel": "provisionReport",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User002/provisionReport",
          "method": "GET"
        }
      ]
    },
    {
      "id": "User003",
      "name": "User Three",
      "email": "user003@example.com",
      "links": [
        {
          "rel": "get",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User003",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User003",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User003",
          "method": "DELETE"
        },
        {
          "rel": "provisionReport",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User003/provisionReport",
          "method": "GET"
        }
      ]
    },
    {
      "id": "User004",
      "name": "User Four",
      "email": "user004@example.com",
      "links": [
        {
          "rel": "get",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User004",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User004",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User004",
          "method": "DELETE"
        },
        {
          "rel": "provisionReport",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User004/provisionReport",
          "method": "GET"
        }
      ]
    },
    {
      "id": "User005",
      "name": "User Five",
      "email": "user005@example.com",
      "links": [
        {
          "rel": "get",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User005",
          "method": "GET"
        },
        {
          "rel": "edit",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User005",
          "method": "PUT"
        },
        {
          "rel": "delete",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User005",
          "method": "DELETE"
        },
        {
          "rel": "provisionReport",
          "href": "https://192.0.2.1:443/essbase/rest/v1/users/User005/provisionReport",
          "method": "GET"
        }
      ]
    }
  ]
}
先頭に戻る