{"id":26897,"date":"2021-02-19T09:33:06","date_gmt":"2021-02-19T09:33:06","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=26897"},"modified":"2022-12-01T09:29:16","modified_gmt":"2022-12-01T09:29:16","slug":"batch-test-execution-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/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

To execute Batch Test Suites and get results. This API only initiates the test process. Please look at the Batch Test Execution Status API<\/a> for results of the batch test.<\/p>\n

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/testsuite\/{testSuiteName}\/run<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\n\n

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

See How to generate the JWT Token<\/a>.<\/p>\n<\/td>\n<\/tr>\n

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Batch Tests Execution<\/li>\n
  • Admin Console: Not Applicable<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Query Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\nMandate<\/th>\n<\/tr>\n<\/thead>\n
    host<\/b><\/span><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/span><\/td>\nRequired<\/td>\n<\/tr>\n
    BotID<\/b><\/td>\nBot ID<\/i> or Stream ID<\/i> can be accessed under General Settings<\/b> on the Bot Builder.<\/span><\/td>\nRequired<\/td>\n<\/tr>\n
    testSuiteName<\/b><\/td>\nName of the test suite on the Bot Builder.<\/span><\/td>\nRequired<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Sample Request<\/span><\/h2>\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\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Body Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/span><\/th>\nDescription<\/span><\/th>\nMandate<\/th>\n<\/tr>\n<\/thead>\n
    version<\/b><\/td>\n\n
    The 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
    		Required<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Sample Response<\/span><\/h2>\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":"To execute Batch Test Suites and get results. This API only initiates the test process. Please look at the Batch Test Execution Status API for results of the batch test.   Method POST Endpoint https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/testsuite\/{testSuiteName}\/run Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Batch Tests Execution...","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\/v10-1\/wp-json\/wp\/v2\/posts\/26897","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=26897"}],"version-history":[{"count":3,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/26897\/revisions"}],"predecessor-version":[{"id":49450,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/26897\/revisions\/49450"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=26897"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=26897"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=26897"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}