プロジェクトの一覧を取得するAPIです。
エンドポイント
URL
https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/projects |
リクエスト
Method | GET |
|
---|---|---|
Header | Authorization |
ログインAPIで払い出したアクセストークンを指定します。 |
Body | なし |
レスポンス
ステータスコード | 成功
エラー
|
---|---|
Body | 成功:JSON 形式 エラー:なし |
URLパラメータ
URLパラメータはありません。
リクエストパラメータ
リクエストパラメータはありません。
レスポンスパラメータ
プロジェクト一覧の取得結果を返却します。
キー | 型 | 必須 | 説明 | |
---|---|---|---|---|
projects |
object 配列 |
– | プロジェクト情報が設定されます。 | |
projectId |
integer |
– | プロジェクトIDが設定されます。 | |
projectName |
string |
– | プロジェクト名が設定されます。 | |
organizationId |
integer |
– | 組織IDが設定されます。 | |
createDate |
string |
– | プロジェクトの作成日時が設定されます。 フォーマット: YYYY-MM-DD hh:mm:ss |
レスポンス例(正常)
1 2 3 4 5 6 7 8 9 10 11 |
{ "projects": [ { "projectId": プロジェクトID "projectName": "プロジェクト名", "organizationId": 組織ID, "createDate": "yyyy-MM-dd HH:mm:ss" } … ] } |
レスポンス例(エラー)
HTTPステータス/原因 | レスポンス内容 | |
---|---|---|
401 (Unauthorized) |
||
トークン不正 | なし | |
パスワードが期限切れもしくは旧式や初期パスワード | なし | |
403 (Forbidden) |
||
アクセス権不正 | なし | |
429 (Too many requests) |
||
ロックアウト | なし |