03-6417-9339

平日 9:30 ~ 12:00 / 13:00 ~ 17:30

lproduct_update


ローカルプロダクトを更新するためのエンドポイントです。

エンドポイント lproduct_update
機能 ローカルプロダクト更新
実装バージョン 2.9.0
認証 有り
HTTPメソッド POST

パラメータ

入力値 機能 入力値の型 デフォルト値
q[api_key] パラメータで認証を行う場合に API キーを指定します。
X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。
String なし
q[lproduct_id] 更新するローカルプロダクトの ID を指定します。 Number なし
q[lprod_name] ローカルプロダクトの名前を指定します。 String なし
q[lprod_priority] 優先度を指定します。 Number 0
q[eol_date] EOL 日付を入力します。 String 10
q[lprod_status] 有効・無効を指定します。有効の場合 "enable" を入力します。 String 無効
q[versions] バージョンを追加したい場合に入力します。配列で複数入力することができます。入力項目は以下の通りです。
  version : バージョン名 String
  priority : 優先度 Number
  release_date : リリース日 String
  support_date : サポート開始日 String
  eol_date : EOL日付 String
  flg_enable : 有効・無効 Boolean

レスポンス

key value の内容 value の型
success 更新の成否 Boolean
response エラー等の補足情報 Hash

レスポンス例

{
  "success": true,
  "response": {}
}

サンプルコード

※ 実際にサンプルコードを試す場合は、色のついている箇所をご自身の環境に合わせて変更しご利用ください。
サンプルコードを試す場合、変更箇所の「http(s)://hostname/redmine」は、システム設定の「メール通知設定用のURL」を、「apikey」は、VM API キー設定画面で登録済みの API キーを設定する必要があります。