プロジェクト登録API

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

プロジェクトの登録を行うAPIです。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects

リクエスト

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

レスポンス

ステータスコード 成功

  • 201(Created)

エラー

  • 400(BadRequest)
  • 401(Unauthorized)
  • 403(Forbidden)
  • 409(Conflict)
  • 429(Too many requests)
Body 成功:JSON形式 エラー:なし

URLパラメータ

URLパラメータはありません。

リクエストパラメータ

キー
必須 説明
projectName string 登録するプロジェクト名を設定します。
最大32文字で設定してください。
organizationId integer 組織登録APIで作成したIDを設定します。

レスポンスパラメータ

登録したプロジェクトのIDを返却します。

登録結果はHTTPステータスコードで確認できます。

キー
必須 説明
projectId integer 登録したプロジェクトのIDが設定されます。

レスポンス例(正常)

レスポンス例(エラー)

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