プロジェクトの更新
説明
指定した ID のプロジェクトを更新します。
必要権限
プロジェクトの管理
URL
PUT /project/projects/{projectIds}
パスパラメーター
名前 | 型 | 必須か | 説明 |
---|---|---|---|
projectIds | string | ○ | プロジェクトID |
リクエストボディ
名前 | 型 | 必須か | 説明 |
---|---|---|---|
name | string | × | プロジェクト名 |
code | string | × | プロジェクトのコード |
description | string | × | プロジェクトの説明 |
managerId | string | × | 管理者ID |
manager | string | × | 管理者 ユーザーの「ログイン名」、「LDAPログイン名」、「メールアドレス」、「名前」に完全一致するユーザーのIDを管理者IDとして更新処理を行います。 |
organizationId | string | × | 所属する組織ID |
organization | string | × | 所属する組織 組織の「コード」、「名前」に完全一致する組織のIDを組織IDとして更新処理を行います。 |
userGroupChange | UserGroupChange | × | 変更するユーザーグループ |
memberChange | MemberChange | × | 変更するメンバー情報 |
forceUnlock | boolean | × | 強制的にロック解除するか true:ロックを解除する。 false:ロックを解除しない。 |
plannedStartDate | DateTime | × | プロジェクト開始日 |
plannedFinishDate | DateTime | × | プロジェクト終了日 |
standardUnitCost | double | × | 標準コスト単価 |
isFinished | boolean | × | プロジェクトを終了するか true:プロジェクトを終了する。 false:プロジェクトを稼働中にする。 |
projectCategories | <string, string>[] | × | プロジェクトカテゴリ |
metadata | <string, string> | × | キーと値のコレクション - 追加時 : 値が null の項目を除いて設定する - 更新時 : キーが指定されなかった項目は変更しない。 (値が null に指定された項目は削除する ) |
レスポンス
名前 | 型 | 説明 |
---|---|---|
ー | UpdatedProject[] | プロジェクトID分のレスポンスを返す。 |
エラーケース
- コードが未指定
- 指定した ID が存在しない
- 指定したユーザーが存在しない
- 指定した所属組織ID が存在しない
- 指定した所属組織 が存在しない
- 管理者IDに指定したユーザーが存在しない
- 管理者に指定したユーザーが存在しない
- コードが重複する
- 開始日と終了日が不正である
- プロジェクトの管理者にユーザー以外を指定する
- メンバから管理者を削除しようとする
- プロジェクトの編集権限がない
- プロジェクトが既にロックされている
- 他ユーザーがロックしたプロジェクトをロック解除ししようとする
- 対象プロジェクトがロックされている
- プロジェクト固有のユーザーグループにプロジェクトメンバーでないパーティを追加しようとする
特記事項
- code のユニークチェックを行うかは、システム設定の「プロジェクトコードをユニークチェックするか」の設定に従います。
- 管理者の所属組織を変更した場合や管理者を他ユーザーに変更した場合でも、プロジェクトの所属組織が自動的に更新されることはありません。
- プロジェクトの期間(開始日、終了日)は、プロジェクトのアイテムの期間に制約を与えません。
- プロジェクトを完了 (isFinished=true) しても、プロジェクトの編集やアイテムの編集には影響しません。
- コスト閲覧権限がない場合はコストの設定は無視します。
- プロジェクトメンバーを削除しても、ワークアイテムのリソースからは削除されません。
- レスポンスの「addedMemberIds」、「addedUserGroupIds」は初回登録時のみ返します。
2回目以降(一旦削除し、再度登録した場合)に登録した場合の Id は、次のAPIから取得してください。
「プロジェクトの取得API」