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

プロジェクトの取得

プロジェクト情報を取得する​

取得対象のプロジェクトの ID を指定して、プロジェクトの取得の API を実行します。

GET /api/project/projects/4
Response
[
  {
      "name": "R商品開発",
      "code": "PRJ-001",
      "description": "",
      "managerId": "42",
      "managerName": "志賀 修造",
      "managerAvatarUrl": null,
      "plannedStartDate": "2022-08-08T00:00:00",
      "plannedFinishDate": "2022-12-30T00:00:00",
      "isFinished": false,
      "workItemRootFolderId": "60",
      "documentItemRootFolderId": "61",
      "canEdit": true,
      "profileId": "5",
      "isLocked": false,
      "lockedAt": null,
      "lockedBy": "0",
      "organizationId": "6",
      "organizationName": "開発1課",
      "lockedApp": "",
      "isDeleted": false,
      "standardUnitCost": 3000.0,
      "aclId": "0",
      "permission": -1,
      "baseProfileId": "30",
      "baseProfileName": "開発部共通のプロファイル",
      "baseProfileVersionName": "1.10",
      "baseProfileNumber": "27",
      "isBaseProfileUpdated": true,
      "projectCategories": null,
      "metadata": {},
      "id": "4",
      "createdAt": "2022-10-13T07:29:30Z",
      "createdBy": "0",
      "updatedAt": "2022-10-17T08:38:17Z",
      "updatedBy": "21"
  }
]

カンマ区切りで複数の ID を指定することで、一度の API 実行で複数のプロジェクトを取得できます。

GET /api/project/projects/4,20,27
注記

複数のプロジェクトを取得できるため、レスポンスは配列です。これは単一の ID を指定した場合も同様です。

プロジェクトカテゴリを含めて取得する​

プロジェクトカテゴリの値を含めてプロジェクトを取得する場合は、projectCategoryFields パラメータに取得対象のプロジェクトカテゴリの名前を指定します。

GET /api/project/projects/4?projectCategoryFields=業務分野,業務種別
Response
[
  {
    ...,
    "projectCategories": {
      "業務分野": "開発",
      "業務種別": "支援"
    },
    ...
  }
]

projectCategoryFields パラメータに * を指定すると、すべてのプロジェクトカテゴリを取得します。

GET /api/project/projects/4?projectCategoryFields=*
注記

パラメータに指定するのはプロジェクトカテゴリのシステム名でなく名前です。 プロジェクトカテゴリの名前は、プロジェクトカテゴリ一覧の取得の API のレスポンスに含まれる各オブジェクトの name から取得できます。

GET /api/system/projectCategories

プロジェクトメンバーを含めて取得する​

プロジェクトメンバーを含めてプロジェクトを取得する場合は、includes パラメータに Members を指定します。

GET /api/project/projects/4?includes=Members
Response
[
  {
    ...,
    "members":[
      {
        "partyId": "14",
        "name": "山本 博",
        "englishName": "",
        "partyType": "User",
        "projectId": "4",
        "projectUserGroupIds": null,
        "unitCost": 3000.0,
        "isDeleted": false,
        "organizationId": "6",
        "organizationName": "開発1課",
        "avatarUrl": null,
        "id": "7",
        "createdAt": "2022-10-13T07:29:30Z",
        "createdBy": "0",
        "updatedAt": "2022-10-13T07:29:30Z",
        "updatedBy": "0"
      },
      {"partyId": "15", "name": "藤井 智一", "englishName": "", "partyType": "User", ...},
      {"partyId": "17", "name": "柴田 智彦", "englishName": "", "partyType": "User", ...},
      ...
    ],
    ...
  }
]

プロジェクトのグループを含めて取得する​

プロジェクトのグループを含めてプロジェクトを取得する場合は、includes パラメータに UserGroups を指定します。

GET /api/project/projects/4?includes=UserGroups
Response
[
  {
    "userGroups": [
      {
        "privateProjectId": "4",
        "isProjectPrivate": true,
        "subGroups": null,
        "name": "QA",
        "englishName": "",
        "code": "",
        "description": "",
        "treePath": "93/",
        "treeDepth": 0,
        "displayOrder": 0.0,
        "isDeleted": false,
        "id": "93",
        "createdAt": "2022-10-17T08:38:17Z",
        "createdBy": "21",
        "updatedAt": "2022-10-17T08:38:17Z",
        "updatedBy": "21"
      },
      {"privateProjectId": "4", "isProjectPrivate": true, "subGroups": null, "name": "Dev", ...},
      {"privateProjectId": "4", "isProjectPrivate": true, "subGroups": null, "name": "Ops", ...}
    ],
    ...
  }
]

プロジェクトのカレンダーを含めて取得する​

プロジェクトのカレンダーを含めてプロジェクトを取得する場合は、includes パラメータに WorkCalendar を指定します。

GET /api/project/projects/4?includes=WorkCalendar
Response
[
  {
    ...,
    "workCalendar": {
      "workDayOfWeek": {
        "sunday": false,
        "monday": true,
        "tuesday": true,
        "wednesday": true,
        "thursday": true,
        "friday": true,
        "saturday": false
      },
      "specifiedWorkDate": {
        "2022-01-01": false,
        "2022-01-10": false,
        "2022-02-11": false,
        "2022-02-23": false,
        "2022-03-21": false,
        "2022-04-29": false,
        "2022-05-03": false,
        "2022-05-04": false,
        "2022-05-05": false,
        "2022-07-18": false,
        "2022-08-11": false,
        "2022-09-19": false,
        "2022-09-23": false,
        "2022-10-10": false,
        "2022-11-03": false,
        "2022-11-23": false
      }
    },
    ...
  }
]
注記

includes パラメータはカンマ区切りで複数指定可能です。 プロジェクトメンバー、グループ、カレンダーをすべて取得する場合は次のように指定します。

GET /api/project/projects/4?includes=Members,UserGroups,WorkCalendar
に最終更新