機械翻訳について

ジャンプ先

• 要求
• レスポンス

グループ・ユーザーの取得

get

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

グループのユーザー・メンバーを取得します。

要求

パス・パラメータ

• id: string

  グループのID。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

グループ・メンバー・リストが正常に返されました。

本文()

ルート・スキーマ : Users

タイプ: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  許可される追加プロパティ: additionalProperties
• totalResults(optional): 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/UserBean"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

タイプ: array

Show Source

• Array of: object User

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

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

タイプ: object

許可される追加プロパティ

Show Source

• string

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

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

内部サーバー・エラー。

先頭に戻る