Create (Import) a Test Suite API
To create a conversation test suite by importing the test cases from a given file. This API returns dsId, the ID to check the import status.
Method
|
POST
|
Endpoint
|
https://{{host}}/api/public/stream/:streamId/conversation/testsuite/import
|
Content Type
|
application/json
|
Authorization
|
auth: {{JWT}}
See How to generate the JWT Token.
|
API Scope
|
- Bot Builder: Conversation Tests Management
- Admin Console: Conversation Tests Management
|
Query Parameters
PARAMETER
|
DESCRIPTION
|
MANDATE
|
host
|
Environment URL. For example,https://bots.kore.ai
|
Required
|
StreamID
|
The Stream ID can be accessed under General Settings on the Bot Builder.
|
Required
|
Sample Request
curl --location --request POST \
'https://{{host}}/api/public/stream/:streamId/conversation/testsuite/import' \
--header 'auth: {YOUR_JWT_ACCESS_TOKEN}' \
--header 'bot-language: {language-code}' \
--header 'Content-Type: application/json' \
--data-raw '{
"fileName": "64dxxxxxxxxxxxxxxxxxxxxc", field(fileId)
"name": "newtestcase",
"tags" : [],
"description" : ""
}'
Body Parameters
PARAMETER
|
DESCRIPTION
|
MANDATE
|
fileName
|
File containing the conversation test suite details.
|
Required
|
name
|
TestSuite Name
|
Required
|
tags
|
Conversation test cases tags list.
|
Optional
|
description
|
Test suite description
|
Optional
|
Sample Response
{
"status": "IN_PROGRESS",
"dsId": "ds-f8xxxxx5-5xxa-5xx4-axx4-48xxxxxxxxx9"
}