機械翻訳について

ジャンプ先

• 要求
• レスポンス

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

get

/essbase/rest/v1/groups

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

要求

問合せパラメータ

• expand(optional): string

  値はallまたはnoneです。 デフォルト値はallで、グループごとにサービス・ロールおよび親グループが返されることを意味します。 noneを指定した場合、サービス・ロールおよび親グループは返されません。

  デフォルト値: all
• filter(optional): string

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

• limit(optional): 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の制限のため表示されません)。

本文()

ルート・スキーマ : グループ

タイプ: 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/GroupBean"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

タイプ: array

Show Source

• Array of: object GroupBean

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

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

タイプ: object

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

Show Source

• string

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

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

タイプ: object

Show Source

• description(optional): string
• groups(optional): array groups
• links(optional): array links
• name(optional): string

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

• role(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "description":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "groups":{
            "type":"array",
            "items":{
                "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

Show Source

• Array of: string

{
    "type":"array",
    "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 レスポンス

内部サーバー・エラー。

先頭に戻る