バッチテストスイートのエクスポ―トのAPI

特定のバッチテストスイートのテストケースをエクスポートし、エクスポートが完了したらファイルをダウンロードするためのリンクを取得します。

このAPIを使用するには、アプリはバッチテストの管理のボットビルダースコープ、またはバッチテストの管理の管理者APIスコープが必要です。

POST https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/export

クエリパラメータ

パラメータ	説明
ホスト	環境URL（例） `https://bots.kore.ai`
BotID	ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。
testSuiteName	エクスポートされるボットのプラットフォームで作成されたテストスイートの名前注意：カスタムバッチテストスイートのみエクスポート可能

認証

以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X POST \ https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/export \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'bot-language: {language-code}' \

サンプル応答

{ "downloadUrl": {{downloadURL}}, "name": "Batch Test Name", "description": "Batch Test Description" }

On this Page

Export Batch Test Suite API

To export the test cases of a given Batch Test Suite and get a link to download the file once the export is completed.

To use this API, the app needs the Bot Builder Scope of Batch Tests Management
OR the Admin API Scope of Batch Tests Management.

POST https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/export

Query Parameters

Parameter Description

host Environment URL, for example, https://bots.kore.ai

BotID Bot ID or Stream ID. You can access it from the General Settings page of the bot.

testSuiteName

Parameter	Description
host	Environment URL, for example, `https://bots.kore.ai`
BotID	Bot ID or Stream ID. You can access it from the General Settings page of the bot.
testSuiteName	Name of the test suite as created in the Bot’s platform to be exported Note: Only Custom Batch Test Suites can be exported

Name of the test suite as created in the Bot’s platform to be exported

Note: Only Custom Batch Test Suites can be exported

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response content type

application/json

Sample Request

curl -X POST \
  https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/export \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'bot-language: {language-code}' \

Sample Response

{
    "downloadUrl": {{downloadURL}},
    "name": "Batch Test Name",
    "description": "Batch Test Description"
}

On this Page