API の一覧

プロジェクトの更新

プロジェクト Markdown で表示

PATCH/api/project/{projectId}

プロジェクトの名前・目的・公開設定・休日の設定を更新します。管理者で、かつプロジェクトのメンバーである場合だけ使えます。

パラメーター

projectIdintegerpath必須
プロジェクトの ID です。

リクエストボディ

namestring
プロジェクトのキーです。英数字と _ - . で 3〜30 文字、スペース内で重複できません。
fullNamestring
プロジェクトの表示名です (255 文字まで)。
purposestring
プロジェクトの目的・説明です (10,000 文字まで)。
isPublicboolean
ログインしていない人でも、公開 URL からタスクの一覧を見られるようにするかどうかです。メンバーの名前とアイコンも公開されます。
holidaysobject[]
プロジェクト独自の休日です (366 件まで)。いまの一覧を置き換えます。
regularHolidaysinteger[]
毎週休みにする曜日です (0 が日曜、6 が土曜)。いまの設定を置き換えます。新しいプロジェクトは [0, 6] です。
avatarUrlnull
null を渡すとプロジェクトのアイコンを外します。
backgroundUrlnull
null を渡すとプロジェクトの背景画像を外します。
productImageUrlnull
null を渡すとプロジェクトのプロダクト画像を外します。

レスポンス

  • 200Updated project detail
  • 400Validation error or project name already exists
  • 401Authentication is required
  • 403Admin only
  • 404Project not found

Repsonaはクッキーを使ってサービスを提供しています。当社のウェブサイトにアクセスすることにより、Cookieポリシー に記載されているCookieの使用に同意するものとします。