メインコンテンツまでスキップ

プロジェクト一覧の取得

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

クエリパラメータになにも指定しない場合、閲覧権限のあるすべてのプロジェクトを取得します。 データ数が多い場合、offset パラメータと limit パラメータを指定して、一度に取得するデータ数を制限できます。

GET /api/project/projects?offset=0&limit=100

稼働中のプロジェクトのみ取得する

終了したプロジェクトを除外して稼働中のプロジェクトのみを取得する場合は isFinished パラメータに false を指定します。

GET /api/project/projects?isFinished=false&offset=0&limit=100

管理プロジェクトを取得する

自分が管理者になっているプロジェクトのみ取得する場合は isManager パラメータに true を指定します。

GET /api/project/projects?isManager=true&offset=0&limit=100

担当プロジェクトを取得する

自分がプロジェクトメンバーになっているプロジェクトのみ取得する場合は isMember パラメータに true を指定します。

GET /api/project/projects?isManager=true&offset=0&limit=100

特定のユーザーが管理者のプロジェクトを取得する

特定のユーザーが管理者になっているプロジェクトのみ取得する場合は managerIds パラメータにユーザーの ID を指定します。

GET /api/project/projects?managerIds=21&offset=0&limit=100
注記

managerIds パラメータはカンマ区切りで複数の ID を指定できます。複数指定した場合は、指定したいずれかのユーザーが管理者となっているプロジェクトを取得します。

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

組織内のプロジェクトのみ取得する場合は organizationIds パラメータに組織の ID を指定します。

GET /api/project/projects?organizationIds=6&offset=0&limit=100
注記

organizationIds パラメータはカンマ区切りで複数の ID を指定できます。複数指定した場合は、指定したいずれかの組織のプロジェクトを取得します。

プロジェクトの名前で検索する

名前に特定の単語を含むプロジェクトのみ取得する場合は name パラメータに検索語を指定します。

GET /api/project/projects?name=開発&offset=0&limit=100

プロジェクトのコードで検索する

特定のコードを持つプロジェクトを取得する場合は code パラメータを使用します。

GET /api/project/projects?code=PRJ-010&offset=0&limit=100
注記

code パラメータは完全一致でプロジェクトを検索します。