シナリオ情報一覧取得API

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

シナリオ情報の一覧を取得するAPIです。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/bots/{botId}/scenarios
https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects/{projectId}/bots/{botId}/scenarios?sort={sort}&order={order}

リクエスト

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を設定します。
sort シナリオ情報一覧の並び替えに使用する情報を以下から設定します。
filenamedescriptionlastmodified
省略した場合はfilenameが設定されます。
order シナリオ情報一覧の並び順を以下から設定します。
ascdesc
省略した場合はascが設定されます。

リクエストパラメータ

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

レスポンスパラメータ

キー
必須 説明
userScenarios object
配列
シナリオ情報を保持します。
   scenarioId string シナリオIDが設定されます。
   description string シナリオの説明が設定されます。
   compileFlag boolean コンパイルフラグが設定されます。
   compilable boolean AIMLファイルが存在するかどうかが設定されます。
   authoring boolean 現在は使用されていません。
   lastModified string 最終更新日時が設定されます。
フォーマット:YYYY-MM-DD hh:mm:ss
templateScenarios object
配列
基本シナリオ情報を保持します。
   scenarioId string 基本シナリオIDが設定されます。
   description string 基本シナリオの説明が設定されます。
   compileFlag boolean コンパイルフラグが設定されます。
  lastModified string 最終更新日時が設定されます。
フォーマット:YYYY-MM-DD hh:mm:ss

レスポンス例(正常)

レスポンス例(エラー)

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