ボットプロパティ更新API

アクセス権限
特権 サーバ管理 テナント管理 シナリオ設計 AIML編集者

ボットプロパティの更新を行うAPIです。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/bots/{botId}/properties

リクエスト

Method PUT
Header Authorization ログインAPIで払い出したアクセストークンを指定します。
  Content-Type application/json;charset=UTF-8
Body JSON形式。(詳細はリクエストパラメータを参照)

レスポンス

ステータスコード

成功

  • 204(No Content)

エラー

  • 400(Bad Request)
  • 401(Unauthorized)
  • 403(Forbidden)
  • 404(Not Found)
  • 429(Too many requests)
Body なし

URLパラメータ

パラメータ名 説明
projectId ボットプロパティを更新する対象のボットが存在するプロジェクトIDを設定します。
botId ボットプロパティを更新する対象のボットIDを設定します。

リクエストパラメータ

更新するボットプロパティを任意のキー:値の形式で設定します。
リクエストパラメータには複数のボットプロパティを設定できます。

キー
必須 説明
(任意) string キーは最大100文字、半角英数字/ハイフン/アンダースコアで設定してください。
値は最大100文字で設定してください。

レスポンスパラメータ

レスポンスパラメータはありません。

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
401(Unauthorized)
  トークン不正 なし
  パスワードが期限切れもしくは旧式や初期パスワード なし
403(Forbidden)
  アクセス権不正 なし
404(Not Found)
  パラメータ不正 なし
429(Too many requests)
  ロックアウト なし