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

プロジェクトの取得


説明

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

必要権限

プロジェクトの閲覧

URL

GET /project/projects/{projectIds}

パスパラメーター

名前必須か説明
projectIdsstringプロジェクトID

クエリパラメーター

名前必須か説明
projectCategoryFieldsstring×プロジェクトカテゴリ名
「*」を指定すると、全てのカテゴリを取得します。
includesstring×取得する従属オブジェクト
(カンマ区切りで複数指定可能です)

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,
"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

名前説明
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>プロジェクトカテゴリ
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×所属組織名

WorkCalendar

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