管理API
ログイン以外のAPIは、払い出されるアクセストークンをHTTP認証ヘッダパラメータに使用すること。
期限切れもしくは旧式や初期パスワードの場合のアクセストークンは、自分のパスワード変更とログアウト以外のAPIは利用できない。
一定回数連続でパスワードを間違えるとロックアウト(429)
| accountName required | string |
| password required | string |
{- "accountName": "AccountName",
- "password": "password1234"
}アクセス権限：サーバ管理者以上
| Authorization required | string |
| organizationName required | string <= 100 characters 組織名 |
| address | string <= 100 characters 住所 |
| tel | string <= 32 characters 電話番号 |
{- "organizationName": "DoCoMo",
- "address": "XXXXXXXX",
- "tel": "01-2345-6789"
}アクセス権限：テナント管理者以上（テナント管理者は所属しているテナントのみ）
| organizationId required | integer 組織ID |
| Authorization required | string アクセストークン |
| organizationId | number 組織ID |
| organizationName | string <= 100 characters 組織名 |
| address | string <= 100 characters 住所 |
| tel | string <= 32 characters 電話番号 |
{- "organizationId": 1,
- "organizationName": "DoCoMo",
- "address": "XXXXXXX",
- "tel": "01-2345-6789"
}アクセス権限：テナント管理者以上（テナント管理者は所属している組織のみ）
| Authorization required | string アクセストークン |
| accountName required | string <= 180 characters アカウント名 |
| password required | string [ 8 .. 180 ] characters パスワード アカウント名と異なる値とすること 英・数・記号の2つ以上を組み合わせること |
| description | string <= 100 characters 表示名 |
| authorization required | integer [ 0 .. 4 ] アクセス権 |
| enable | boolean アカウント利用可否フラグ。未指定の場合、true |
| eternity | boolean 2.6.3以降 パスワード有効期限を無期限（2038年まで有効) にする。(特権・サーバ管理者のみ指定可能)。 未指定の場合、false |
{- "accountName": "DoCoMoUser",
- "password": "password1234",
- "description": "ドコモ",
- "authorization": 1,
- "enable": true,
- "eternity": false
}アクセス権限：全員(シナリオ設計者及びAIML編集者は自身のみ)
| accountId required | integer アカウントID |
| Authorization required | string アクセストークン |
| accountName | string <= 180 characters アカウント名 |
| password | string [ 8 .. 180 ] characters パスワード アカウント名と異なる値とすること 英・数・記号の2つ以上を組み合わせること |
| description | string <= 100 characters 表示名 |
| authorization | integer [ 0 .. 4 ] アクセス権 |
| enable | boolean アカウント利用可否フラグ。未指定の場合、true |
| eternity | boolean パスワード有効期限を無期限（2038年まで有効) にする。(特権・サーバ管理者のみ指定可能) 未指定の場合、false |
{- "accountName": "DoCoMo",
- "password": "password1234",
- "description": "ドコモ",
- "authorization": 1,
- "enable": true,
- "eternity": false
}アクセス権限：全員
| Authorization required | string アクセストークン |
| old required | string 現在のパスワード |
| new required | string [ 8 .. 180 ] characters 新しいパスワード アカウント名と異なる値とすること 英・数・記号の2つ以上を組み合わせること |
{- "old": "password1234",
- "new": "password4321"
}アクセス権限：テナント管理者以上
| Authorization required | string アクセストークン |
| projectName required | string <= 32 characters プロジェクト名。 projectNameは全組織でユニーク(2.6.14以降) |
| organizationId required | integer 組織ID |
{- "projectName": "DoCoMo",
- "organizationId": 1
}アクセス権限：シナリオ設計者以上
| projectId required | integer プロジェクトID |
| Authorization required | string アクセストークン |
| botId required | string <= 100 characters ボットID 最大100文字 "{プロジェクト名}_"で始まっていること(2.6.14以降) 半角大小英数字/ハイフン/アンダースコア以外はBadRequest(400) |
| scenarioProjectId required | string シナリオプロジェクトID |
| language required | string 設定言語。「ja-JP」や「en-JP」などシステムでサポートされている言語 |
| description | string <= 100 characters ボット説明文 |
| sraix | string sraix範囲(global/public/project/null) テナント管理者以上が指定可能 省略時のデフォルトは "null" |
{- "botId": "DocCoMo_InitBot",
- "scenarioProjectId": "DSU",
- "language": "ja-JP",
- "description": "対話入り口Bot",
- "sraix": "global"
}アクセス権限：シナリオ設計者以上
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
| botId | string <= 100 characters ボットID |
| scenarioProjectId | string シナリオプロジェクトID |
| language | string 設定言語 |
| description | string <= 100 characters ボット説明文 |
| sraix | string sraix範囲(global/public/project/null) |
{- "botId": "DocCoMo_InitBot",
- "scenarioProjectId": "DSU",
- "language": "ja-JP",
- "description": "対話入り口Bot",
- "sraix": "global"
}アクセス権限：シナリオ設計者以上
オプションで詳細条件jsonを指定可能。最大10件。
| projectId required | integer プロジェクトID |
| botId | string ボットID。省略時は全ボットが対象。 |
| start | string 検索期間(開始日)。省略時は全期間 yyyy-MM-dd HH:mm:ss ミリ秒部分は自動で000 |
| end | string 検索期間(終了日)。省略時は全期間 yyyy-MM-dd HH:mm:ss ミリ秒部分は自動で999 |
| offset | integer 取得開始インデックス。省略時は0 |
| limit | integer 最大件数。省略時の最大件数はサーバ側の設定値による。 |
| mode | string 取得するログ項目。省略時はmin。 minで取得する項目は以下。 requestDateTime/ userId/ botId/ language/ input/ output/ responseTime |
| Authorization required | string アクセストークン |
Array of objects (scenarioLogDetails) |
{- "details": [
- {
- "operation": "NOT",
- "target": "string",
- "query": "string"
}
]
}アクセス権限：シナリオ設計者以上
| projectId required | integer プロジェクトID |
| botId | string ボットID。省略時は全ボットが対象。 |
| start | string 検索期間(開始日)。省略時は全期間 yyyy-MM-dd HH:mm:ss ミリ秒部分は自動で000 |
| end | string 検索期間(終了日)。省略時は全期間 yyyy-MM-dd HH:mm:ss ミリ秒部分は自動で999 |
| Authorization required | string アクセストークン |
Array of objects (scenarioLogDetails) |
{- "details": [
- {
- "operation": "NOT",
- "target": "string",
- "query": "string"
}
]
}アクセス権限：シナリオ設計者以上
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
| key | string <= 100 characters predicateのキー、値も100文字が上限 |
{- "key": "string"
}アクセス権限：シナリオ設計者以上
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
| key | string <= 100 characters predicateのキー、値も100文字が上限 |
{- "key": "string"
}アクセス権限：シナリオ設計者以上
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
| key | string <= 100 characters predicateのキー、値も100文字が上限 |
{- "key": "string"
}アクセス権限：シナリオ設計者以上
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
| key | string <= 100 characters predicateのキー、値も100文字が上限 |
{- "key": "string"
}アクセス権限：全員
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
| key | string <= 100 characters predicateのキー 値は100000文字が上限(2.6.14以降) |
{- "key": "string"
}アクセス権限：全員
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
| key | string <= 100 characters predicateのキー 値は100000文字が上限(2.6.14以降) |
{- "key": "string"
}アクセス権限：シナリオ設計者以上
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
| predicateNames required | Array of strings[ items <= 100 characters ] |
{- "predicateNames": [
- "name"
]
}アクセス権限：全員
ファイルサイズ制限はサーバの設定値による。
権限外のファイルは無視される。
aiml、dat、map、set, ans, ng のほか、次を含めることが可能。(対応バージョン：2.6.11以降)
■ボット属性ファイル (テナント管理者)
ファイル名：botattr.properties
フォーマット：{キー}={値}
scope=global/public/project/null のみ
■ボット設定ファイル (シナリオ設計者)
ファイル名：botconf.properties
フォーマット：{キー}={値}
■ボットプロパティファイル (シナリオ設計者)
ファイル名：bot.properties
フォーマット：{キー}={値}
■デフォルトPredicateファイル (シナリオ設計者)
ファイル名：preddef.properties
フォーマット：{キー}={値}
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
| uploadFile required | string <binary> |
アクセス権限：全員
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
required | Array of objects |
{- "userScenarios": [
- {
- "scenarioId": "WEATHER",
- "description": "天気に関するトピック",
- "compileFlag": true
}
]
}アクセス権限：全員
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| sort | string filename/description/lastmodified。デフォルトはfilename |
| order | string asc/desc。デフォルトはasc |
| offset | integer 取得開始インデックス。省略時は0(2.6.17以降) |
| limit | integer 最大件数。省略時の最大件数はサーバ側の設定値による。(2.6.17以降) |
| Authorization required | string アクセストークン |
アクセス権限：全員
| projectId required | integer プロジェクトID |
| botId required | string ボットID |
| Authorization required | string アクセストークン |
Array of objects | |
Array of objects |
{- "userScenarios": [
- {
- "scenarioId": "WEATHER",
- "description": "天気に関するトピック",
- "compileFlag": true
}
], - "templateScenarios": [
- {
- "scenarioId": "QUIZ",
- "description": "QUIZに関するトピック",
- "compileFlag": true
}
]
}dictionary、schemaは、プロパティファイルで指定するファイルの内容を応答する
| accountName required | string アカウント名 |
| password required | string パスワード |
| botId required | string ボットID |
{- "accountName": "DoCoMo",
- "password": "pass1234",
- "botId": "DoCoMo_InitBot"
}