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

プロジェクトプロファイルの取得

基本情報を取得する​

プロジェクトの ID を指定して、プロジェクトプロファイルの取得の API を実行します。

GET /api/project/projects/27/profile

以下のようなレスポンスが返ります。

Response
[
  {
    "name": "プロファイル",
    "versionName": "",
    "code": "",
    "description": "",
    "revisedContent": "",
    "profileNumber": "30",
    "revision": 1,
    "baseProfileId": "30",
    "baseProfileNumber": "27",
    "baseProfileName": null,
    "isProjectPrivate": true,
    "privateProjectId": "27",
    "isPublished": true,
    "profileCategoryId": "0",
    "profileCategoryName": null,
    "isDeleted": false,
    "timeEntryCategoryRequiredInTimeEntry": false,
    "processCategoryRequiredInTimeEntry": false,
    "lastBaseAppliedAt": "2022-11-28T02:18:57Z",
    "configUpdatedAt": "2022-11-12T23:09:12Z",
    "isCustomized": false,
    "metadata": {},
    "id": "31",
    "createdAt": "2022-10-17T06:00:01Z",
    "createdBy": "21",
    "updatedAt": "2022-11-12T23:09:12Z",
    "updatedBy": "21"
  }
]
注意

レスポンスは配列ですが、要素数は常に 1 です。

関連オブジェクトを取得する​

includes パラメータを使用することで、プロファイルに関連オブジェクトを含めることができます。includes パラメータには次の値を指定できます。

  • ItemTypes
  • FieldTypes
  • StatusTypes
  • ProjectProperties
注記

カンマ区切りで複数の値を指定できます。

アイテムタイプ​

includes パラメータに ItemTypes を指定した場合、プロジェクト内で使用可能なアイテムタイプの一覧を itemTypes フィールドに含めて返します。

GET /api/project/projects/27/profile?includes=ItemTypes
Response
[
  {
    "itemTypes": [
      {"itemTypeId": "1", "name": "プロジェクト", "systemName": "WorkItemRoot", "code": "", ...},
      {"itemTypeId": "2", "name": "プロジェクト", "systemName": "DocumentItemRoot", "code": "", ...},
      {"itemTypeId": "3", "name": "タスク", "systemName": "Task", "code": "", ...},
      {"itemTypeId": "4", "name": "パッケージ", "systemName": "Package", "code": "", ...}
    ],
    "name": "プロファイル",
    "versionName": "",
    ...
  }
]

各アイテムタイプは、自身の属性に加えて、そのアイテムタイプで使用可能なフィールドとステータスの一覧を保持します。

注意

itemTypeCategory が Project のアイテムタイプは、システムが内部で使用するアイテムタイプであり、ユーザーは使用することができません。

注記

アイテムタイプが持つフィールドやステータスのデータは ID などの一部のデータのみです。 フィールドやステータスに関する完全な情報は includes パラメータに FieldTypes や StatusTypes を指定して取得できるデータと組み合わせる必要があります。

フィールド​

includes パラメータに FieldTypes を指定した場合、プロジェクト内のいずれかのアイテムタイプで使用可能なフィールドの一覧を fieldTypes フィールドに含めて返します。

GET /api/project/projects/27/profile?includes=FieldTypes
Response
[
  {
    "fieldTypes": [
      {"id": "1", "name": "ID", "systemName": "Id", "category": "Common", ...},
      {"id": "2", "name": "プロジェクトID", "systemName": "ProjectId", "category": "Common", ...},
      {"id": "3", "name": "プロジェクト名", "systemName": "ProjectName", "category": "Common", ...},
      {"id": "4", "name": "プロジェクトコード", "systemName": "ProjectCode", "category": "Common", ...},
      ...
    ],
    "name": "プロファイル",
    "versionName": "",
    ...
  }
]

ステータス​

includes パラメータに StatusTypes を指定した場合、プロジェクト内のいずれかのアイテムタイプで使用可能なステータスの一覧を statusTypes フィールドに含めて返します。

GET /api/project/projects/27/profile?includes=StatusTypes
Response
[
  {
    "statusTypes": [
      {"id": "1", "groupId": "1", "name": "未着手", "color": "#BDBDBD", ...},
      {"id": "2", "groupId": "2", "name": "作業中", "color": "#303F9F", ...},
      {"id": "3", "groupId": "3", "name": "完了", "color": "#00FF00", ...},
      {"id": "4", "groupId": "4", "name": "保留", "color": "", ...}
    ],
    "name": "プロファイル",
    "versionName": "",
    ...
  }
]

プロパティ​

includes パラメータに ProjectProperties を指定した場合、プロパティの一覧を projectProperties フィールドに含めて返します。

Response
[
  {
    "projectProperties":[
      {"systemName": "Difficulty", "name": "難易度", "description": "", "allowedValues": "高,中,低", ...},
      {"systemName": "Productivity", "name": "生産性", "description": "", "allowedValues": "", ...}
    ],
    "name": "プロファイル",
    "versionName": "",
    ...
  }
]
注記

プロパティは計算式で使用できる変数です。

に最終更新