YouTrack および Hub ヘルプの開発者ポータル

すべてのロールを取得

リクエスト

GET [[[<REST API URL>|Hub-Rest-Api-URL.html]]]/roles?fields=string&amp;$skip=int&amp;$top=int&amp;query=string&amp;orderBy=string

パラメーター

説明

fields

オプション。各ロールの指定されたフィールドのサブセットのみを返します。サブセットを定義するには、フィールド構文を使用します。

$skip

オプション。最初のロールを返す前にスキップするロール数を設定できます。

$top

オプション。返されるロールの最大数を設定できます。

query

オプション。検索クエリを指定して、返される結果をフィルタリングできます。サポートされている論理演算構文の定義については、照会の構文を参照してください。ロールでは、以下のフィールドとタプルがサポートされています。

has : permission — いくつかの権限を持つデフォルトのロール

id : value — 指定された ID のサービスのデフォルトのロール

key : value — 指定されたキーを持つデフォルトのロール

name : value — 指定された名前のデフォルトのロール

permission : permission — 指定された権限を含むデフォルトのロール

has : permission — いくつかの権限を持つロール

id : value — 指定された ID のロール

key : roleKey — 指定されたキーを持つロール

name : roleName — 名のロール

permission : permission — 与えられた許可を含むロール

permission ( key : permissionKey , service : service ) — 指定された権限を含むロール

permission ( service : service ) — サービスから少なくとも 1 つの権限を持つロール

orderBy

オプション。指定されたフィールドでソートされたロールのリストを返します。詳細はソート構文を参照してください。ロールは、以下のフィールドによる並べ替えをサポートしています: key name key name

レスポンス

レスポンスコード

意味

200 OK

リクエストが成功しました。

400 不正な要求

リクエストパラメーターの少なくとも 1 つが無効です。例: 渡された JSON オブジェクトの必須フィールドがありません。詳細については、応答のエラーメッセージを確認してください。

403 禁止します

要求元は、要求されたリソースにアクセスできません。

404 お探しのページが見つかりませんでした

要求されたリソースが見つかりませんでした。

500 内部サーバーエラー

サーバーエラーのため、リクエストの処理に失敗しました。詳細については、応答のエラーメッセージを確認してください。

レスポンスボディ

{ "skip": int, "top": int, "total": int, "roles": [[[[role|HUB-REST-API_JSON-Scheme.html#role]]], ...] }
2025 年 9 月 26 日