ボットプロパティ取得API

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

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

エンドポイント

URL

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

リクエスト

Method GET
Header Authorization ログインAPIで払い出したアクセストークンを指定します。
Body なし

レスポンス

ステータスコード

成功

  • 200(OK)

エラー

  • 400(Bad Request)
  • 401(Unauthorized)
  • 403(Forbidden)
  • 404(Not Found)
  • 429(Too many requests)
Body 成功:JSON形式 エラー:なし

URLパラメータ

パラメータ名 説明
projectId ボットプロパティを取得する対象のボットが存在するプロジェクトIDを設定します。
botId ボットプロパティを取得する対象のボットIDを設定します。
names 取得対象のボットプロパティのキーを設定します。
キーは「,」(カンマ)区切りで複数同時に指定できます。

リクエストパラメータ

リクエストパラメータはありません。

レスポンスパラメータ

登録されているボットプロパティをキー:値の形式で返却します。

キー
必須 説明
(任意) string 登録されているボットプロパティが設定されます。

レスポンス例(正常)

レスポンス例(エラー)

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