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

組織のすべてのプロジェクトを取得する

リクエスト

GET <REST API URL>/organizations/{organization id}/projects?fields=string&$skip=int&$top=int&query=string&orderBy=string

パラメーター

説明

fields

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

$skip

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

$top

オプション。返すプロジェクトの最大数を設定できます。

query

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

accessible (for : user , with : role) — 指定されたユーザーが指定されたロールを持つプロジェクトを返します

accessible (for : group , with : role) — 指定されたグループが指定されたロールを持つプロジェクトを返します

accessible (for : service , with : role) — 指定されたサービスが指定されたロールを持つプロジェクトを返します

accessible (for : user , with : permission) — 指定されたユーザーが指定された権限を持っているプロジェクトを返します

accessible (for : group , with : permission) — 指定されたグループが指定された権限を持っているプロジェクトを返します

accessible (for : service , with : permission) — 指定されたサービスが指定された権限を持っているプロジェクトを返します

accessible (for : user) — 指定されたユーザーが任意の権限を持っているプロジェクトを返します

accessible (for : group) — 指定されたグループに権限があるプロジェクトを返します

accessible (for : service) — 指定されたサービスに権限があるプロジェクトを返します

accessible (with : role) — 誰かが指定されたロールを持つプロジェクトを返します

accessible (with : permission) — 誰かが指定された権限を持っているプロジェクトを返します

after : instant — 指定された瞬間の後に作成されたプロジェクトを返します

before : instant — 指定された瞬間より前に作成されたプロジェクトを返します

favorite (for : user) — 指定されたユーザーのお気に入りのプロジェクトを返します

has : resource — 少なくとも 1 つのリソースを持つプロジェクトを返します

has : organization — 組織に割り当てられているプロジェクトを返します

id : value — 指定された ID のプロジェクト

is : global — グローバルプロジェクトを返します

is : archived — アーカイブされたプロジェクトを返します

is : favorite — 現在のユーザーのお気に入りのプロジェクトを返します

key : projectKey — 指定されたキーを持つプロジェクトを返します

name : projectName — 指定された名前のプロジェクトを返します

organization : organization — 指定された組織に割り当てられているプロジェクトを返します

resource : resource — 指定されたリソースを持つプロジェクトを返します

resource (key : resourceKey , service : service) — 指定されたサービスのリソースを持つプロジェクトを返します

resource (name : resourceName , service : service) — 指定されたサービスのリソースを持つプロジェクトを返します

resource (service : service) — 指定されたサービスのリソースが少なくとも 1 つあるプロジェクトを返します

type : project type — 指定されたプロジェクトタイプのプロジェクトのリストを返します

orderBy

オプション。指定されたフィールドでソートされたプロジェクトのリストを返します。詳細については、ソート構文を参照してください。プロジェクトは、次のフィールドによる順序付けをサポートしています: creationTimekeynameorganization

レスポンス

レスポンスコード

意味

200 OK

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

400 不正な要求

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

403 禁止します

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

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

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

500 内部サーバーエラー

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

レスポンスボディ

{ "skip": int, "top": int, "total": int, "projects": [project, ...] }