Oracle EssbaseのREST API

機械翻訳について

ユーザーの更新

put

/essbase/rest/v1/users/{id}

ユーザーを更新します。

要求

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

application/json
application/xml

パス・パラメータ

id: string

ユーザーのID。

更新されたユーザー。

ルート・スキーマ : User

タイプ: object

Show Source

email(optional): string

ユーザーの電子メール・アドレス。
groups(optional): array groups

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

ユーザーID。
links(optional): array links
name(optional): string

ユーザー名。 256文字に制限されます。次の特殊文字は使用できません: ; , = + * ? [ ] | < > \ " ' / Space Tab。また、グループ名にピリオド(.)は使用できません。
password(optional): string

ユーザーのパスワード。
role(optional): string

ユーザー・ロール。有効なロール: User、パワー・ユーザーおよびサービス管理者。
token(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "token":{
            "type":"string"
        },
        "role":{
            "type":"string",
            "description":"<p>The user role. Valid roles: <b>User</b>, <b>Power User</b>, and <b>Service Administrator</b>.</p>"
        },
        "groups":{
            "type":"array",
            "description":"<p>Comma-separated list of group names associated with this user.</p>",
            "items":{
                "type":"string"
            }
        },
        "password":{
            "type":"string",
            "description":"<p>Password for the user.</p>"
        },
        "email":{
            "type":"string",
            "description":"<p>E-mail address of the user.</p>"
        },
        "id":{
            "type":"string",
            "description":"<p>The user ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The user 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>"
        }
    },
    "xml":{
        "name":"User"
    }
}

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

タイプ: array

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

Show Source

Array of: string

{
    "type":"array",
    "description":"<p>Comma-separated list of group names associated with this user.</p>",
    "items":{
        "type":"string"
    }
}

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

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

ユーザーは正常に更新されました。

ルート・スキーマ : User

タイプ: object

Show Source

email(optional): string

ユーザーの電子メール・アドレス。
groups(optional): array groups

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

ユーザーID。
links(optional): array links
name(optional): string

ユーザー名。 256文字に制限されます。次の特殊文字は使用できません: ; , = + * ? [ ] | < > \ " ' / Space Tab。また、グループ名にピリオド(.)は使用できません。
password(optional): string

ユーザーのパスワード。
role(optional): string

ユーザー・ロール。有効なロール: User、パワー・ユーザーおよびサービス管理者。
token(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "token":{
            "type":"string"
        },
        "role":{
            "type":"string",
            "description":"<p>The user role. Valid roles: <b>User</b>, <b>Power User</b>, and <b>Service Administrator</b>.</p>"
        },
        "groups":{
            "type":"array",
            "description":"<p>Comma-separated list of group names associated with this user.</p>",
            "items":{
                "type":"string"
            }
        },
        "password":{
            "type":"string",
            "description":"<p>Password for the user.</p>"
        },
        "email":{
            "type":"string",
            "description":"<p>E-mail address of the user.</p>"
        },
        "id":{
            "type":"string",
            "description":"<p>The user ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The user 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>"
        }
    },
    "xml":{
        "name":"User"
    }
}

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

タイプ: array

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

Show Source

Array of: string

{
    "type":"array",
    "description":"<p>Comma-separated list of group names associated with this user.</p>",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : 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にアクセスし、Essbaseユーザーを更新する方法を示します。

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

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

call properties.bat

curl -X PUT "https://192.0.2.1:443/essbase/rest/v1/users/jenp" 
     -H  "accept: application/json" 
     -H  "Content-Type: application/json" 
     -d "{  \"role\": \"Power User\",  
            \"email\": \"jen.x.power@example.com\",
            \"id\": \"jenp\",
            \"name\": \"Jen Power\"
         }"
     -u %User%:%Password%

レスポンス本体の例

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

{
  "id": "jenp",
  "name": "Jen Power",
  "email": "jen.x.power@example.com",
  "role": "Power User",
  "links": [
    {
      "rel": "get",
      "href": "https://192.0.2.1:443/essbase/rest/v1/users/jenp",
      "method": "GET"
    },
    {
      "rel": "edit",
      "href": "https://192.0.2.1:443/essbase/rest/v1/users/jenp",
      "method": "PUT"
    },
    {
      "rel": "delete",
      "href": "https://192.0.2.1:443/essbase/rest/v1/users/jenp",
      "method": "DELETE"
    },
    {
      "rel": "provisionReport",
      "href": "https://192.0.2.1:443/essbase/rest/v1/users/jenp/provisionReport",
      "method": "GET"
    }
  ]
}

先頭に戻る