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

---

説明

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

プロジェクトのプロファイルとは

各プロジェクトで保持するプロファイルです。

必要権限

なし

URL

GET /project/projects/{projectId}/profile

パスパラメーター

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

クエリパラメーター

名前	型	必須か	説明
includes	string	×	追加で取得するプロファイルの詳細情報 ※includesを指定しない場合は、フィールド自体取得されません。 カンマ区切りで以下の値を複数指定できます。 ・ItemTypes：アイテムタイプ ・FieldTypes：フィールドタイプ ・StatusTypes：ステータスタイプ ・ProjectProperties：プロジェクト変数

レスポンス

名前	型	説明
ー	ProjectProfile[]	取得したプロファイル情報

エラーケース

なし

特記事項

なし。

サンプル

ID:27のプロジェクトのプロファイルを取得する

GET /project/projects/27/profile?includes=ItemTypes,FieldTypes,StatusTypes

Response

200 OK

[
    {
        "statusTypes": [
            {
                "id": "1",
                "groupId": "1",
                "name": "未着手",
                "color": "#BDBDBD",
                "code": "",
                "description": "",
                "displayOrder": 0.166666666666667
            },
            ・
            ・
            ・
        ],
        "itemTypes": [
            ・
            ・
            ・
            {
                "itemTypeId": "4",
                "name": "パッケージ",
                "systemName": "Package",
                "code": "",
                "color": "",
                "description": "",
                "iconName": "folder",
                "baseType": "Task",
                "itemTypeCategory": "WorkItem",
                "isSystemItemType": true,
                "isFolder": true,
                "isContentType": false,
                "canInputTimeEntry": false,
                "config": {
                    "name": "パッケージ",
                    "allowedSubItemTypeIds": [
                    ],
                    "allowedTimeEntryCategoryIds": [
                    ],
                    "allowedProcessCategoryIds": [
                    ],
                    "itemTypeId": null
                },
                "displayOrder": 0.666666666666667,
                "initialStatusTypeId": null,
                "isDeleted": false,
                "fields": [
                    {
                        "fieldTypeId": "1",
                        "displayOrder": 0.0125,
                        "isDeleted": false,
                        "config": {
                        },
                        "isCustomized": false
                    },
                    ・
                    ・
                    ・
                ],
                "statusTypes": [
                    {
                        "statusTypeId": "1",
                        "progress": 0.0,
                        "isDeleted": false
                    },
                    ・
                    ・
                    ・
                ],
                "formLayouts": [
                ],
                "isCustomized": false,
                "isStatusCustomized": false
            },
            ・
            ・
            ・
        ],
        "fieldTypes": [
            {
                "id": "1",
                "name": "ID",
                "systemName": "Id",
                "category": "Common",
                "code": "",
                "description": "",
                "group": "システム",
                "fieldCode": "1",
                "dataType": "DTItem",
                "isSystemField": true,
                "isVisible": true,
                "isCustomizable": false,
                "isQueryable": true,
                "allowedFieldCalcTypes": [
                    "None"
                ],
                "defaultConfig": {
                    "profileId": "31",
                    "fieldTypeId": "1",
                    "name": "ID",
                    "isRequired": false,
                    "isEditable": false,
                    "defaultValue": "",
                    "allowedValues": "",
                    "minValue": "",
                    "maxValue": "",
                    "minLength": 0,
                    "maxLength": 0,
                    "validationRegex": "",
                    "format": "",
                    "isExpression": false,
                    "isChildRelated": false,
                    "expressions": [
                    ],
                    "defaultFieldCalcType": "None",
                    "defaultFieldCalcTypeWithChildren": "None",
                    "minLines": 0,
                    "formatCategory": "",
                    "decimalDigits": 0,
                    "unitName": "",
                    "currency": "",
                    "useDigitSeparators": false,
                    "isDeleted": false,
                    "isDerived": true,
                    "isCustomized": false
                }
            },
            ・
            ・
            ・
        ],
        "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": "2023-08-14T02:18:57Z",
        "configUpdatedAt": "2023-07-29T23:09:12Z",
        "isCustomized": false,
        "metadata": {
        },
        "id": "31",
        "createdAt": "2023-07-03T06:00:01Z",
        "createdBy": "21",
        "updatedAt": "2023-07-29T23:09:12Z",
        "updatedBy": "21"
    }
]

型定義

ProjectProfile

名前	型	説明
id	string	プロファイルID
name	string	プロファイル名
versionName	string	バージョン名
code	string	プロファイルのコード
description	string	プロファイルの説明
baseProfileId	ProfileId	継承元プロファイルID
baseProfileName	string	継承元プロファイル名
revision	int	改訂番号
revisedContent	string	改訂内容
configUpdatedAt	DateTime	プロファイル設定更新日時
isProjectPrivate	boolean	プロジェクトプロファイルか
privateProjectId	string	所属するプロジェクトのID
isPublished	boolean	公開状態 ・true：公開 ・false：非公開
timeEntryCategoryRequiredInTimeEntry	boolean	実績入力時に作業分類の設定を必要とするか。 trueの場合、タイムシートで作業分類の設定が必要になります。
processCategoryRequiredInTimeEntry	boolean	実績入力時に工程分類の設定を必要とするか。 trueの場合、タイムシートで工程分類の設定が必要になります。
lastBaseAppliedAt	DateTime	継承元プロファイルの最終反映日時
itemTypes	ItemUse[]	利用アイテムタイプ
fieldTypes	ProjectFieldType[]	利用フィールドタイプ
statusTypes	ProjectStatusType[]	利用スタータスタイプ
isDeleted	boolean	削除されているか
projectProperties	ProjectProperty[]	プロジェクト変数

ItemUse

名前	型	説明
ItemTypeId	string	フィールドタイプID
name	string	名前
systemName	string	システム名
code	string	コード
description	string	説明
itemTypeCategory	string	アイテムタイプカテゴリ 以下の値を設定できます。 - Project：プロジェクト - WorkItem: ワークアイテム
color	Color	アイテムタイプの色
iconName	string	アイコン名 以下の値を設定できます。 - folder - layers - clipboard - date - book - shield - circle - broken - hecagon - cube - rhombus
isSystemItemType	boolean	システムのアイテムタイプか ・true：システムのアイテムタイプ ・false：ユーザーが作成したアイテムタイプ
isFolder	boolean	このアイテムタイプがフォルダか
canInputTimeEntry	boolean	実績入力できるか
displayOrder	double	アイテムタイプの表示順序。 UIで表示する際の表示順序を示します。
fields	FieldUse[]	利用フィールド
statusTypes	StatusUse[]	実績入力できるか
isDeleted	boolean	削除されているか
initialStatusTypeId	string	初期ステータスID

FieldUse

名前	型	説明
fieldTypeId	string	フィールドタイプID
isDerived	boolean	派生か
displayOrder	double	フィールドタイプの表示順序。 UIで表示する際の表示順序を示します。
isDeleted	boolean	削除されているか

StatusUse

名前	型	説明
statusTypeId	string	ステータスタイプID
progress	double	ステータスに対応する進捗
isDeleted	boolean	削除されているか

ProjectFieldType

名前	型	説明
id	string	フィールドタイプID
name	string	名前
systemName	string	システム名
code	string	コード
description	string	説明
group	string	グループ
dataType	DataType	定義するフィールドのデータ型
allowedFieldCalcTypes	FieldCalcType[]	設定可能なフィールドの決定方法
isSystemField	boolean	システムフィールドか ・true：システムフィールド ・false：カスタムフィールド
defaultFieldConfigs	DefaultFieldConfig[]	プロファイル共通のフィールド設定

DataType

名前	型	説明
DTSingleLineText	string	単一行テキスト
DTMultiLineText	string	複数行テキスト
DTInt	string	整数
DTDouble	string	実数
DTDate	string	日付
DTBool	string	論理値
DTColor	string	カラー
DTCost	string	コスト
DTProgress	string	進捗率
DTTimeValue	string	工数
DTDocumentSize	string	成果量
DTUser	string	ユーザー
DTProject	string	プロジェクト
DTItem	string	アイテム
DTStatusType	string	ステータスタイプ
DTItemType	string	アイテムタイプ
DTProcessCategory	string	工程分類
DTTimeEntryCategory	string	作業分類
DTObject	string	オブジェクト

FieldCalcType(列挙体)

名前	説明
None	無効値
UserInput	ユーザー入力
Sum	合計
Average	平均
Max	最大
Min	最小
And	論理積
Or	論理和
Count	個数
ProgressNA	進捗管理なし
ProgressOutputScale	規模進捗
ProgressWeightedAverage	加重平均
ProgressRemainingTime	進捗率(残作業時間)
Auto	自動計算
Expression	計算式

DefaultFieldConfig

名前	型	説明
isDerived	boolean	派生されたものか
isCustomized	boolean	カスタマイズされたか

ProjectStatusType

名前	型	説明
id	string	ステータスタイプID
name	string	名前
code	string	コード
description	string	説明
groupId	string	ステータスタイプグループID
displayOrder	double	ステータスタイプの表示順序。 UIで表示する際の表示順序を示します。

ProjectProperty

名前	型	説明
systemName	string	システム名
name	string	表示名
description	string	説明
allowedValues	string	入力可能な値 カンマ区切りで選択可能な値を指定する。 指定がない場合は自由入力 例：allowedValues: "必ず再現,不明,不定"
type	string	変数の型 - number:数値型 - string:文字列型 - date:日付型
value	object	値 typeがnumberの場合、数値型で返却される.
isDerived	boolean	派生されたものか
isCustomized	boolean	カスタマイズされたか