Test Cases
This chapter focuses on services for the test cases.
Updates from version 1.2.0:
-
There are 3 types of test case: standard, scripted and keyword.
-
The "kind" property is no longer available in test case. The test case type is, instead, specified/defined by "_type" property.
-
The "script" property is from now available only for scripted test case.
-
There is no longer "language" property in test case. The language for scripted test case is always GHERKIN while there is no defined language for standard and keyword test cases.
Get all test cases
A GET
to /test-cases
returns all the test-cases that the client is allowed to read.
Type ('all', 'standard', 'scripted' or 'keyword') can be added as filter parameter to return the test cases with specific type.
HTTP request
Snippet http-request not found for operation::RestTestCaseGetControllerIT/browse-test-cases
Request parameters
Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/browse-test-cases
HTTP response
Snippet http-response not found for operation::RestTestCaseGetControllerIT/browse-test-cases
Response fields
Snippet response-fields not found for operation::RestTestCaseGetControllerIT/browse-test-cases
Links
Snippet links not found for operation::RestTestCaseGetControllerIT/browse-test-cases
Get test case
A GET
to /test-cases/{id}
returns the test case with the given id.
Path parameters
Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case
HTTP request
Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-test-case
Request parameters
Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case
HTTP response
Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-test-case
Response fields
Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-test-case
Links
Snippet links not found for operation::RestTestCaseGetControllerIT/get-test-case
Create test case
A POST
to /test-cases
creates a new test case. By default the created test case will be of "standard" type, to create a "scripted"
or a "keyword" test case, you need to specify additional property in your payload : "_type": "scripted-test-case" or "keyword-test-case".
-
Create a standard test case
HTTP request
Snippet http-request not found for operation::RestTestCasePostControllerIT/post-test-case
HTTP response
Snippet http-response not found for operation::RestTestCasePostControllerIT/post-test-case
-
Create a scripted test case
HTTP request
Snippet http-request not found for operation::RestTestCasePostControllerIT/post-scripted-test-case
HTTP response
Snippet http-response not found for operation::RestTestCasePostControllerIT/post-scripted-test-case
-
Create a keyword test case
HTTP request
Snippet http-request not found for operation::RestTestCasePostControllerIT/post-keyword-test-case
HTTP response
Snippet http-response not found for operation::RestTestCasePostControllerIT/post-keyword-test-case
Modify test case
A PATCH
to /test-cases/{id}
modifies the test case with the given id.
-
Modify a standard test case
HTTP request
Snippet http-request not found for operation::RestTestCasePostControllerIT/patch-test-case
HTTP response
Snippet http-response not found for operation::RestTestCasePostControllerIT/patch-test-case
-
Modify a scripted test case
HTTP request
Snippet http-request not found for operation::RestTestCasePostControllerIT/patch-scripted-test-case
HTTP response
Snippet http-response not found for operation::RestTestCasePostControllerIT/patch-scripted-test-case
-
Modify a keyword test case
HTTP request
Snippet http-request not found for operation::RestTestCasePostControllerIT/patch-keyword-test-case
HTTP response
Snippet http-response not found for operation::RestTestCasePostControllerIT/patch-keyword-test-case
Get datasets of test case
A GET
to /test-cases/{id}/datasets
returns all the datasets of the test case with the given id.
Path parameters
Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets
HTTP request
Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets
Request parameters
Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets
HTTP response
Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets
Response fields
Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets
Links
Snippet links not found for operation::RestTestCaseGetControllerIT/get-test-case-datasets
Get parameters of test case
A GET
to /test-cases/{id}/parameters
returns all the parameters of the test case with the given id.
Path parameters
Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters
HTTP request
Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters
Request parameters
Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters
HTTP response
Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters
Response fields
Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters
Links
Snippet links not found for operation::RestTestCaseGetControllerIT/get-test-case-parameters
Get steps of test case
A GET
to /test-cases/{id}/steps
returns all the steps of the test case with the given id.
-
In case of a standard test case :
Path parameters
Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-steps
HTTP request
Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-test-case-steps
Request parameters
Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-test-case-steps
HTTP response
Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-test-case-steps
Response fields
Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-test-case-steps
Links
Snippet links not found for operation::RestTestCaseGetControllerIT/get-test-case-steps
-
In case of a keyword test case :
Path parameters
Snippet path-parameters not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps
HTTP request
Snippet http-request not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps
Request parameters
Snippet request-parameters not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps
HTTP response
Snippet http-response not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps
Response fields
Snippet response-fields not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps
Links
Snippet links not found for operation::RestTestCaseGetControllerIT/get-keyword-test-case-steps
Delete test case
A DELETE
to /test-cases/{ids}
deletes one or several test cases/folders with the given id(s).
When a lot of test case should be deleted, the system will determine which of them are really deletable according to the business rules. Once this sorting is done only the deletable items will actually be deleted.
The service returns a list of messages that indicates the result of the operation. If everything goes as expected, this list will be empty. In the case where certain elements could not be deleted (for business rules), the service will return one or more messages which will indicate it to you. Note that these messages are the same as those displayed in the user interface.
Optionally we can pass in parameter 'dry-run = true'. In this case only the diagnostics and messages are returned, but no test case will be deleted.
Path parameters
Snippet path-parameters not found for operation::RestTestCasePostControllerIT/delete-test-case
HTTP request
Snippet http-request not found for operation::RestTestCasePostControllerIT/delete-test-case
Request parameters
Snippet request-parameters not found for operation::RestTestCasePostControllerIT/delete-test-case
HTTP response
Snippet http-response not found for operation::RestTestCasePostControllerIT/delete-test-case