プロジェクトの取得

説明

指定した ID のプロジェクトを取得します。

必要権限

プロジェクトの閲覧

URL

GET /project/projects/{projectIds}

パスパラメーター

名前	型	必須か	説明
projectIds	string	○	プロジェクトID

クエリパラメーター

名前	型	必須か	説明
projectCategoryFields	string	×	プロジェクトカテゴリ名「*」を指定すると、全てのカテゴリを取得します。
includes	string	×	取得する従属オブジェクト（カンマ区切りで複数指定可能です） UserGroups：プロジェクトのユーザーグループを取得します。 Members：メンバーを取得します。 WorkCalendar：カレンダーを取得します。

レスポンス

名前	型	説明
ー	Project[]	取得したプロジェクト情報

エラーケース

指定した ID が存在しない

特記事項

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

サンプル

プロジェクトIDを指定してプロジェクトを取得する（プロジェクトメンバーを含む）

GET /project/projects/6?includes=Members

Response
200 OK

[
    {
        "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,
        "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"
    }
]

型定義

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
projectCategories	<string, string>	プロジェクトカテゴリ
allowEditingItemsWithBrowsePermission	boolean	閲覧権限があるアイテムの編集を許可する
recordTransitionData	boolean	プロジェクトの推移データを記録するか
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: 非稼働日

説明​

必要権限​

URL​

パスパラメーター​

クエリパラメーター​

レスポンス​

エラーケース​

特記事項​

サンプル​

プロジェクトIDを指定してプロジェクトを取得する（プロジェクトメンバーを含む）​

型定義​

Project​

UserGroup​

Member​

WorkCalendar​

説明

必要権限

URL

パスパラメーター

クエリパラメーター

レスポンス

エラーケース

特記事項

サンプル

プロジェクトIDを指定してプロジェクトを取得する（プロジェクトメンバーを含む）

型定義

Project

UserGroup

Member

WorkCalendar