{"id":26897,"date":"2021-02-19T09:33:06","date_gmt":"2021-02-19T09:33:06","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-0\/?p=26897"},"modified":"2021-03-18T10:22:43","modified_gmt":"2021-03-18T10:22:43","slug":"batch-test-execution-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-0\/docs\/bots\/api-guide\/batch-test-execution-api\/","title":{"rendered":"Batch Test Execution API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Used to execute Batch Test Suites and get results. This API only initiates the test process. Use Batch Test Execution Status API<\/a> to view the results of the batch test.<\/p>\n

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

POST<\/b> https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/testsuite\/{testSuiteName}\/run<\/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’s platform<\/span><\/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

Body Parameters<\/span><\/h3>\n\n\n\n\n\n
Parameter<\/span><\/th>\nDescription<\/span><\/th>\n<\/tr>\n<\/thead>\n
version<\/td>\nThe version of the bot against which the execution is required<\/p>\n
    \n
  • published for Published version<\/li>\n
  • inDevelopment for the <\/span>Configured version<\/li>\n<\/ul>\n<\/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 --location --request POST \\\r\n      'https:\/\/{host}\/api\/public\/stream\/{streamId}\/testsuite\/{testSuiteName}\/run' \\\r\n      --header 'auth: {jwt-token}' \\\r\n      --header 'bot-language: {language-code}' \\\r\n      --header 'Content-Type: application\/json' \\\r\n      --data-raw '{\r\n         \"version\":\"inDevelopment\" \r\n         }'\r\n<\/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    \"status\": \"accepted\",\r\n    \"requestId\": \"tr-acfxxbff-xxxf-xaxx-bbbx-exxxabaxxcxx\"\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":"Used to execute Batch Test Suites and get results. This API only initiates the test process. Use Batch Test Execution Status API to view the results of the batch test. To use this API, the app needs the Bot Builder Scope of Batch Tests Execution. POST https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/testsuite\/{testSuiteName}\/run Query Parameters Parameter Description host Environment URL, for...","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-26897","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\/26897","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=26897"}],"version-history":[{"count":1,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/26897\/revisions"}],"predecessor-version":[{"id":26898,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/posts\/26897\/revisions\/26898"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/media?parent=26897"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/categories?post=26897"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-0\/wp-json\/wp\/v2\/tags?post=26897"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}