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

プロジェクト一覧の取得

説明​

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

必要権限​

プロジェクトの閲覧

URL​

GET /project/projects

クエリパラメーター​

名前型必須か説明
namestring×プロジェクト名
codestring×プロジェクトのコード(完全一致)
organizationIdsstring×組織ID
organizationsstring×組織

組織の「コード」、「名前」のいずれかに完全一致する組織に所属するプロジェクトの検索処理を行います。
organizationNamestring×組織名
managerIdsstring×取得対象とする管理者ID
managerOrganizationIdsstring×マネージャが所属する組織ID
managersstring×取得対象とする管理者

ユーザーの「ログイン名」、「LDAPログイン名」、「メールアドレス」、「名前」のいずれかに完全一致するプロジェクト管理者を持つプロジェクトの検索処理を行います。
managerNamestring×管理者名
isManagerboolean×true：自身が管理者のプロジェクトのみを取得します。
false：自身が管理者でないプロジェクトのみを取得します。
指定なし：フィルターを行いません。
assignedUserIdsstring×フィルターするユーザーID

指定した ID のいずれかのユーザーが割り当てられたアイテムがあるプロジェクトを取得します。
isMemberboolean×true：API実行者がメンバーのプロジェクトを取得します。
false：API実行者がメンバーでないプロジェクトを取得します。
指定なし：フィルターを行いません。
keywordstring×キーワード

以下のフィールドに指定したキーワードを持つプロジェクトを取得します。
・プロジェクト名
・プロジェクトのコード
・組織名
・管理者名
・プロジェクトカテゴリ名(プロジェクトカテゴリに設定されている値を指定してください。)
projectCategoryFieldsstring×取得対象のプロジェクトカテゴリ名を記載します。
「*」を指定すると、全てのカテゴリを取得します。
isLockedboolean×true：ロックされているプロジェクトのみを取得します。
false：ロックされていないプロジェクトのみを取得します。
指定なし：フィルターを行いません。
isFinishedboolean×true：終了したプロジェクトのみを取得します。
false：稼働中のプロジェクトのみを取得します。
指定なし：フィルターを行いません。
canInputTimeEntryUserIdsstring×指定したユーザーIDが工数入力可能なアイテムを含むプロジェクトを取得します。

具体的には以下のどちらかの条件に合致するプロジェクト。
- アイテムにリソースとして割り当てられている。
- 「コラボレータ」として設定されたプロジェクト
includesstring×取得する従属オブジェクト
（カンマ区切りで複数指定可能です）

UserGroups：プロジェクトのユーザーグループを取得します。
Members：メンバーを取得します。
WorkCalendar：カレンダーを取得します。
orderbystring×並び替えに用いるフィールド

フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。
asc：昇順（既定値）
desc：降順
includeDeletedboolean×削除済みデータも取得対象とするか

true：削除されたデータを含めて取得します。
false：削除されていないデータのみを取得します。
isDeletedboolean×includeDeleted =trueのとき有効とします。

true：削除されたデータのみを取得します。
false：削除されていないデータのみを取得します。
limitint×データの最大取得件数
offsetint×何件目のデータから取得するか

省略した場合の既定値は 0 で先頭のデータから取得します。

コラボレータとは​

進捗管理や成果物の状況を管理したいプロジェクトメンバとは異なり、
他プロジェクトからの一時的な協力者や、プロジェクト全体のレビューや作業を共同で作成する方も
1つ1つのアイテムにリソースを割り当てるのは手間です。

その場合、上記メンバを『コラボレータ』にすることで、リソースを割り当てなくても工数を入力できます。
コラボレータは以下のどちらかをプロジェクトで設定します。

レスポンス​

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

エラーケース​

  • なし

特記事項​

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

サンプル​

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

GET /project/projects?isManager=true&includes=Members
Response
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,
            "recordTransitionData":true,
            "allowEditingItemsWithBrowsePermission":true,
            "allowTimeEntryForAll":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,
            "recordTransitionData":true,
            "allowEditingItemsWithBrowsePermission":true,
            "allowTimeEntryForAll":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​

名前型説明
idstringID
namestring名前
codestringコード
descriptionstring説明
managerIdstring管理者ID
managerNamestringマネージャ名
organizationIdstring組織ID
organizationNamestring組織名
workItemRootFolderIdstringルートのワークアイテムフォルダID
profileIdstringプロファイルID
baseProfileIdstring継承元プロファイルID
baseProfileNamestring継承元プロファイル名
baseProfileVersionNamestring継承元プロファイルのバージョン名
membersMemberメンバー一覧
userGroupsUserGroupユーザーグループ一覧
isLockedbooleanロックされているか
lockedAtDateTimeロック日時
（ isLocked=false の場合は null です。）
isDeletedboolean論理削除されているか
isFinishedbooleanプロジェクトが完了しているか
plannedStartDateDateTimeプロジェクト開始日
plannedFinishDateDateTimeプロジェクト終了日
standardUnitCostdouble標準コスト単価
workCalendarWorkCalendarカレンダー
aclIdstringACLID
projectCategories<string, string>プロジェクトカテゴリ
allowEditingItemsWithBrowsePermissionboolean閲覧権限があるアイテムの編集を許可する
recordTransitionDatabooleanプロジェクトの推移データを記録するか
allowTimeEntryForAllbooleanすべてのアイテムに工数入力を許可するか
createdAtDateTime作成日時
createdBystring作成者のユーザーID
updatedAtDateTime更新日時
updatedBystring更新者のユーザーID

UserGroup​

名前型説明
idstringユーザーグループID
namestringユーザーグループ名
englishNamestringユーザーグループの英語名
codestringユーザーグループのコード
descriptionstringユーザーグループの説明
treePathstringツリーパス
treeDepthintツリーの深さ
isProjectPrivatebooleanプロジェクトグループか
true：プロジェクトで作成したユーザーグループ
false：システムで作成したユーザーグループ
privateProjectIdstring所属するプロジェクトID
subGroupsUserGroup[]保持しているサブグループ情報一覧
displayOrderdoubleユーザーグループの表示順。
UIで表示する際の表示順序を示します。
isDeletedboolean削除されているか
createdAtDateTime作成日時
createdBystring作成者のユーザーID
updatedAtDateTime更新日時
updatedBystring更新者のユーザーID

Member​

名前型必須か説明
partyIdstring○メンバとして割り当たっているユーザーもしくはユーザーグループのID
namestring×名前
englishNamestring×英語名
partyTypestring○メンバの種類。
以下の値を設定できます。
・User：ユーザー
projectIdstring×プロジェクトID
projectUserGroupIdsstring×メンバーが所属するプロジェクトのユーザーグループIDの一覧
createdAtDateTime×作成日時
createdBystring×作成者のユーザID
updatedAtDateTime×更新日時
updatedBystring×更新者のユーザID
idstring×プロジェクトのメンバID
isDeletedboolean×論理削除されているか
codestring×コード
unitCostdouble×コスト単価
organizationIdstring×所属組織ID
organizationNamestring×所属組織名
isCollaboratorboolean×協力者か

WorkCalendar​

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