03-6417-9339

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

upload_offline_data


SIDfmVMエージェントのオフラインモードで取得したJSONデータをアップロードするためのエンドポイントです。

エンドポイント upload_offline_data
機能 SIDfm VM Agent のオフラインモードで取得した JSON ファイルを取り込む
実装バージョン 2.8.0
認証 有り
HTTPメソッド POST

パラメータ

入力値 機能 入力値の型 デフォルト値
q[api_key] パラメータで認証を行う場合に API キーを指定します。
X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。
String なし
q[system_category_id] 新ホスト登録時の「システム」カテゴリのIDを指定します。新規ホスト登録が発生しなければ使用されません。 Number なし
q[custom_category_id] 新ホスト登録時の「カスタム」カテゴリのIDを指定します。新規ホスト登録が発生しなければ使用されません。 Number 0
q[file_data] 取り込みたいjsonファイルの内容を指定します。JSONファイルの内容をURIエンコードしたjsonデータを設定してください。 String なし

レスポンス

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

レスポンス例

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

サンプルコード

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