組織一覧取得API

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

組織の一覧を取得するAPIです。

エンドポイント

URL

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

リクエスト

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

レスポンス

ステータスコード 成功

  • 200(OK)

エラー

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

URLパラメータ

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

リクエストパラメータ

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

レスポンスパラメータ

キー 必須 説明
organizations object
配列
組織の情報が配列で設定されます。
  organizationId integer 組織IDが設定されます。
  organizationName string 組織名が設定されます。
  address string 住所が設定されます。
  tel string 電話番号が設定されます。

レスポンス例(正常)

レスポンス例(エラー)

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