プロジェクト一覧の取得

説明

プロジェクトの一覧を取得します。

必要権限

プロジェクトの閲覧

URL

GET /project/projects

クエリパラメーター

名前	型	必須か	説明
name	string	×	プロジェクト名
code	string	×	プロジェクトのコード
organizationIds	string	×	組織ID
organizations	string	×	組織 組織の「コード」、「名前」のいずれかに完全一致する組織に所属するプロジェクトの検索処理を行います。
organizationName	string	×	組織名
managerIds	string	×	取得対象とする管理者ID
managerOrganizationIds	string	×	マネージャが所属する組織ID
itemIds	string	×	アイテムID
managers	string	×	取得対象とする管理者 ユーザーの「ログイン名」、「LDAPログイン名」、「メールアドレス」、「名前」のいずれかに完全一致するプロジェクト管理者を持つプロジェクトの検索処理を行います。
managerName	string	×	管理者名
isManager	boolean	×	true：自身が管理者のプロジェクトのみを取得します。 false：自身が管理者でないプロジェクトのみを取得します。 指定なし：フィルターを行いません。
assignedUserIds	string	×	フィルターするユーザーID 指定した ID のいずれかのユーザーが割り当てられたアイテムがあるプロジェクトを取得します。
isMember	boolean	×	true：API実行者がメンバーのプロジェクトを取得します。 false：API実行者がメンバーでないプロジェクトを取得します。 指定なし：フィルターを行いません。
keyword	string	×	キーワード 以下のフィールドに指定したキーワードを持つプロジェクトを取得します。 ・プロジェクト名 ・プロジェクトのコード ・組織名 ・管理者名 ・プロジェクトカテゴリ名
projectCategoryFields	string	×	取得対象のプロジェクトカテゴリ名を記載します。 プロジェクトカテゴリ名以外では、以下を指定することができます。 ・*：全カテゴリを取得します。 ・#：集計対象のみを取得します。
isLocked	boolean	×	true：ロックされているプロジェクトのみを取得します。 false：ロックされていないプロジェクトのみを取得します。 指定なし：フィルターを行いません。
isFinished	boolean	×	true：終了したプロジェクトのみを取得します。 false：稼働中のプロジェクトのみを取得します。 指定なし：フィルターを行いません。
canInputTimeEntryUserIds	string	×	工数入力可能なユーザーID 指定したIDのいずれかのユーザーが工数入力可能なアイテムがあるプロジェクトを取得します。
includes	string	×	取得する従属オブジェクト （カンマ区切りで複数指定可能です） UserGroups：プロジェクトのユーザーグループを取得します。 Members：メンバーを取得します。 WorkCalendar：カレンダーを取得します。 Metadata：ユーザー拡張用フィールドを取得します。
orderby	string	×	並び替えに用いるフィールド フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。 asc：昇順（既定値） desc：降順
includeDeleted	boolean	×	削除済みデータも取得対象とするか true：削除されたデータを含めて取得します。 false：削除されていないデータのみを取得します。
isDeleted	boolean	×	includeDeleted =trueのとき有効とします。 true：削除されたデータのみを取得します。 false：削除されていないデータのみを取得します。
limit	int	×	データの最大取得件数
offset	int	×	何件目のデータから取得するか 省略した場合の既定値は 0 で先頭のデータから取得します。

レスポンス

名前	型	説明
totalCount	int	検索条件に該当するプロジェクトの総数
data	Project[]	取得したプロジェクト一覧

エラーケース

• なし

特記事項

コスト閲覧権限がない場合はコスト単価は 0 で取得します。

サンプル

Web APIの実行者が管理者のプロジェクトを一覧で取得する（プロジェクトメンバーを含む）

リクエスト

GET /project/projects?isManager=true&includes=Members

レスポンス

200 OK

{
    "totalCount":6,
    "data":[
        {
            "name":"S機器の開発",
            "code":"PRJ-002",
            "description":"",
            "managerId":"21",
            "managerName":"岡本 直哉",
            "plannedStartDate":"2018-11-05T00:00:00",
            "plannedFinishDate":"2019-03-20T00:00:00",
            "isFinished":false,
            "workItemRootFolderId":"123",
            "documentItemRootFolderId":"124",
            "members":[
                {"partyId":"14","name":"山本 博","englishName":"","partyType":"User",・・・},
                {"partyId":"15","name":"藤井 智一","englishName":"","partyType":"User",・・・},
                {"partyId":"17","name":"柴田 智彦","englishName":"","partyType":"User",・・・},
                {"partyId":"21","name":"岡本 直哉","englishName":"","partyType":"User",・・・},
                {"partyId":"23","name":"植田 信貴","englishName":"","partyType":"User",・・・},
                {"partyId":"40","name":"黒川 悠太","englishName":"","partyType":"User",・・・}
            ],
            "canEdit":true,
            "profileId":"7",
            ”baseProfileId":"1",
            "baseProfileName":"デフォルトのプロファイル",
            "baseProfileVersionName":"1.00",
            "isLocked":false,
            "lockedAt":null,
            "lockedBy":"0",
            "organizationId":"6",
            "organizationName":"開発1課",
            "lockedApp":"",
            "isDeleted":false,
            "aclId":"0",
            "permission":63441024,
            "standardUnitCost":3000.0,
            "projectCategories":null,
            "metadata":{},
            "id":"6",
            "createdAt":"2019-01-10T07:29:32Z",
            "createdBy":"0",
            "updatedAt":"2019-02-01T09:16:15Z",
            "updatedBy":"21"
        },
        {
            "name":"L商品の開発",
            "code":"PRJ-201",
            "description":"",
            "managerId":"21",
            "managerName":"岡本 直哉",
            "plannedStartDate":"2018-10-22T00:00:00",
            "plannedFinishDate":"2019-05-11T00:00:00",
            "isFinished":false,
            "workItemRootFolderId":"604",
            "documentItemRootFolderId":"605",
            "members":[
                {"partyId":"14","name":"山本 博","englishName":"","partyType":"User",・・・},
                {"partyId":"21","name":"岡本 直哉","englishName":"","partyType":"User",・・・},
                {"partyId":"23","name":"植田 信貴","englishName":"","partyType":"User",・・・},
                {"partyId":"40","name":"黒川 悠太","englishName":"","partyType":"User",・・・},
                {"partyId":"41","name":"藤岡 康史","englishName":"","partyType":"User",・・・},
                {"partyId":"42","name":"志賀 修造","englishName":"","partyType":"User",・・・},
                {"partyId":"43","name":"高畑 哲也","englishName":"","partyType":"User",・・・}
            ],
            "canEdit":true,
            "profileId":"17",
            ”baseProfileId":"2",
            "baseProfileName":"デフォルトのプロファイル",
            "baseProfileVersionName":"1.00",
            "isLocked":false,
            "lockedAt":null,
            "lockedBy":"0",
            "organizationId":"6",
            "organizationName":"開発1課",
            "lockedApp":"",
            "isDeleted":false,
            "aclId":"0",
            "permission":63441024,
            "standardUnitCost":3000.0,
            "projectCategories":null,
            "metadata":{},
            "id":"16",
            "createdAt":"2019-01-10T07:29:38Z",
            "createdBy":"0",
            "updatedAt":"2019-01-10T07:29:38Z",
            "updatedBy":"0"
        },
        ・
        ・
        ・
    ]
}

型定義

Project

名前	型	説明
id	string	ID
name	string	名前
code	string	コード
description	string	説明
managerId	string	管理者ID
managerName	string	マネージャ名
organizationId	string	組織ID
organizationName	string	組織名
workItemRootFolderId	string	ルートのワークアイテムフォルダID
profileId	string	プロファイルID
baseProfileId	string	継承元プロファイルID
baseProfileName	string	継承元プロファイル名
baseProfileVersionName	string	継承元プロファイルのバージョン名
members	Member	メンバー一覧
userGroups	UserGroup	ユーザーグループ一覧
isLocked	boolean	ロックされているか
lockedAt	DateTime	ロック日時 （ isLocked=false の場合は null です。）
isDeleted	boolean	論理削除されているか
isFinished	boolean	プロジェクトが完了しているか
plannedStartDate	DateTime	プロジェクト開始日
plannedFinishDate	DateTime	プロジェクト終了日
standardUnitCost	double	標準コスト単価
workCalendar	WorkCalendar	カレンダー
aclId	string	ACLID
metadata	<string, object>	拡張用メタデータ
projectCategories	<string, string>	プロジェクトカテゴリ
createdAt	DateTime	作成日時
createdBy	string	作成者のユーザーID
updatedAt	DateTime	更新日時
updatedBy	string	更新者のユーザーID

UserGroup

名前	型	説明
id	string	ユーザーグループID
name	string	ユーザーグループ名
englishName	string	ユーザーグループの英語名
code	string	ユーザーグループのコード
description	string	ユーザーグループの説明
treePath	string	ツリーパス
treeDepth	int	ツリーの深さ
isProjectPrivate	boolean	プロジェクトグループか true：プロジェクトで作成したユーザーグループ false：システムで作成したユーザーグループ
privateProjectId	string	所属するプロジェクトID
subGroups	UserGroup[]	保持しているサブグループ情報一覧
displayOrder	double	ユーザーグループの表示順。 UIで表示する際の表示順序を示します。
isDeleted	boolean	削除されているか
createdAt	DateTime	作成日時
createdBy	string	作成者のユーザーID
updatedAt	DateTime	更新日時
updatedBy	string	更新者のユーザーID

Member

名前	型	必須か	説明
partyId	string	○	メンバとして割り当たっているユーザーもしくはユーザーグループのID
name	string	×	名前
englishName	string	×	英語名
partyType	string	○	メンバの種類。 以下の値を設定できます。 ・User：ユーザー
projectId	string	×	プロジェクトID
projectUserGroupIds	string	×	メンバーが所属するプロジェクトのユーザーグループIDの一覧
createdAt	DateTime	×	作成日時
createdBy	string	×	作成者のユーザID
updatedAt	DateTime	×	更新日時
updatedBy	string	×	更新者のユーザID
id	string	×	プロジェクトのメンバID
isDeleted	boolean	×	論理削除されているか
code	string	×	コード
unitCost	double	×	コスト単価
organizationId	string	×	所属組織ID
organizationName	string	×	所属組織名

WorkCalendar

名前	型	必須か	説明
specifiedWorkDate	<Date, boolean>	×	特定日が稼働日かどうか。 true: 稼働日 false: 非稼働日
workDayOfWeek	<string, boolean>	×	曜日が稼働日かどうか。 true: 稼働日 false: 非稼働日