プロジェクトメンバーの取得
プロジェクトメンバーを取得する場合、ユーザー一覧の取得 API を使用する方法と、プロジェクトの取得 API を使用する方法があります。
ユーザー一覧の取得 API を使用してプロジェクトメンバーを取得する
ユーザー一覧の取得 API を使用してプロジェクトメンバーを取得します。
GET /system/users
パラメータの指定
-
assignedProjectIds
assignedProjectIds
パラメータにプロジェクトの ID を指定します。GET /system/users?assignedProjectIds=47
レスポンス
API を実行すると以下のようなレスポンスが返ります。
Response
{
"totalCount": 4,
"data": [
{
"name": "岡本 直哉",
"englishName": "",
"loginName": "okamoto",
"email": "",
"code": "008",
"organizationName": "開発2課",
"language": "ja-JP",
"timeZone": "Asia/Tokyo",
"isDeleted": false,
"unitCost": 8000.0,
"organizationId": "7",
"timeEntryLockedDate": "1753-01-01T00:00:00",
"description": "",
"ldapLoginName": "",
"systemRoleId": "1",
"systemRoleName": "システム管理者",
"avatarUrl": null,
"canEdit": true,
"allowLocalAuthentication": false,
"aclId": "0",
"permission": -1,
"id": "21",
"createdAt": "2023-09-07T07:29:22Z",
"createdBy": "0",
"updatedAt": "2023-09-14T07:17:47Z",
"updatedBy": "21"
},
{ "name": "黒川 悠太", "englishName": "", "loginName": "kurokawa", "id": "40", ・・・ },
{ "name": "高畑 哲也", "englishName": "", "loginName": "takahata", "id": "43", ・・・ },
{ "name": "高木 拓也", "englishName": "", "loginName": "takagi", "id": "83", ・・・ }
]
}
プロジェクトの取得 API を使用してプロジェクトメンバーを取得する
プロジェクトの取得 API を使用してプロジェクトメンバーを取得します。
GET /project/projects/{projectIds}
パラメータの指定
-
includes
includes
パラメータには、プロジェクト情報に含めるオブジェクトを指定します。
指定できるオブジェクトは、UserGroup(プロジェクトのユーザーグループ)
、Members(メンバー)
、WorkCalender(カレンダー)
です。
この例では、プロジェクトメンバーを含めてプロジェクトを取得するためにMembers
を指定します。GET /project/projects/47?includes=Members
レスポンス
API を実行すると以下のようなレスポンスが返ります。
members
フィールドで、プロジェクトメンバーを確認できます。
Response
[
{
"name": "A製品の開発",
"code": "",
"description": "",
"managerId": "21",
"managerName": "岡本 直哉",
・・・,
"members": [
{
"partyId": "21",
"name": "岡本 直哉",
"englishName": "",
"partyType": "User",
"id": "251",
"projectId": "47",
"projectUserGroupIds": null,
"unitCost": 8000.0,
"isDeleted": false,
"organizationId": "7",
"organizationName": "開発2課",
"avatarUrl": null,
"createdAt": "2023-09-13T08:44:16Z",
"createdBy": "21",
"updatedAt": "2023-09-13T08:44:16Z",
"updatedBy": "21"
},
{ "partyId": "40", "name": "黒川 悠太", "englishName": "", "partyType": "User", "id: "255", ・・・ },
{ "partyId": "43", "name": "高畑 哲也", "englishName": "", "partyType": "User", "id: "256", ・・・ },
{ "partyId": "83", "name": "高木 拓也", "englishName": "", "partyType": "User", "id: "258", ・・・ },
],
・・・
}
]
メンバー情報のフィールドのうち、 partyId
はユーザー ID を表し、 id
はプロジェクト上でのメンバー ID を表します。