コンパイル状態確認API

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

ボット単位でxAIMLファイルのコンパイル状況を確認するAPIです。

エンドポイント

URL

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

リクエスト

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

レスポンス

ステータスコード

成功

  • 200(OK)

エラー

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

URLパラメータ

パラメータ名 説明
projectId コンパイル状態を確認するプロジェクトIDを指定します。
botId コンパイル状態を確認するボットIDを指定します。

リクエストパラメータ

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

レスポンスパラメータ

キー 必須 説明
status string コンパイル状況が設定されます。内容は以下のいずれかです。

  • Completed(コンパイル済み)
  • Processing(コンパイル処理中)
  • ErrorFinish(エラー終了)
  • NotCompiled(コンパイル未実行)
created string 最後にコンパイルが成功した日時またはDATファイルの最終アップロード日時が設定されます。
フォーマット:YYYY-MM-DD hh:mm:ss
error string エラー内容が設定されます。

レスポンス例(正常)

レスポンス例(エラー)

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