{"id":26903,"date":"2021-02-19T09:36:05","date_gmt":"2021-02-19T09:36:05","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-0\/?p=26903"},"modified":"2021-03-18T10:59:19","modified_gmt":"2021-03-18T10:59:19","slug":"export-batch-test-suite-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-0\/docs\/bots\/api-guide\/export-batch-test-suite-api\/","title":{"rendered":"Export Batch Test Suite API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To export the test cases of a given Batch Test Suite and get a link to download the file once the export is completed.<\/p>\n

To use this API, the app needs the Bot Builder Scope of Batch Tests Management
\nOR the Admin API Scope of Batch Tests Management.<\/p>\n

POST<\/b> https:\/\/{host}\/api\/public\/bot\/{botId}\/testsuite\/{testSuiteName}\/export<\/code><\/span><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
host<\/span><\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/code><\/span><\/td>\n<\/tr>\n
BotID<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/span><\/td>\n<\/tr>\n
testSuiteName<\/td>\nName of the test suite as created in the Bot\u2019s platform to be exported<\/span><\/p>\n

Note: Only Custom Batch Test Suites can be exported<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h3>\n

Invoke the API with JWT in the header with the following syntax:<\/p>\n

auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response content type<\/span><\/h3>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\n
curl -X POST \\\r\n  https:\/\/{host}\/api\/public\/bot\/{botId}\/testsuite\/{testSuiteName}\/export \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}<\/em>' \\\r\n  -H 'bot-language: {language-code}'<\/span> \\<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
{\r\n    \"downloadUrl\": {{downloadURL}},\r\n    \"name\": \"Batch Test Name\",\r\n    \"description\": \"Batch Test Description\"\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-26903","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/26903","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/comments?post=26903"}],"version-history":[{"count":1,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/26903\/revisions"}],"predecessor-version":[{"id":26904,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/26903\/revisions\/26904"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/media?parent=26903"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/categories?post=26903"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/tags?post=26903"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}