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

ロールのすべての権限を取得する

リクエスト

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

パラメーター

説明

fields

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

$skip

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

$top

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

query

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

entityType : permissionEntityType — 指定された entityType の権限

id : value — 指定された ID での許可

is : global — すべてのグローバル権限

key : permissionKey — 指定されたキーによるアクセス許可

name : permissionName — 与えられた名前の許可

operation : permissionOperation — 特定の操作の権限

role : role — 指定されたロールの権限

service : service — 特定のサービスによって提供されるアクセス許可

orderBy

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

レスポンス

レスポンスコード

意味

200 OK

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

400 不正な要求

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

403 禁止します

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

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

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

500 内部サーバーエラー

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

レスポンスボディ

{ "skip": int, "top": int, "total": int, "permissions": [[[[permission|HUB-REST-API_JSON-Scheme.html#permission]]], ...] }
2024 年 10 月 14 日