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

すべてのプロファイル属性プロトタイプを取得

リクエスト

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

パラメーター

説明

fields

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

$skip

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

$top

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

query

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

id : value — 指定された ID の ProfileAttributePrototype

name : prototypeName — 指定された名前のカスタム属性を返します

orderBy

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

レスポンス

レスポンスコード

意味

200 OK

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

400 不正な要求

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

403 禁止します

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

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

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

500 内部サーバーエラー

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

レスポンスボディ

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