Test Center API v3
Number of APIs: 30
1. Test runs - Submit a test run
POST https://{{host}}/test-management/v3/test-runs
Submits a test run for functional testing. With one request you can run the test for a property version, test suite, and functional test case.
GET https://{{host}}/test-management/v3/test-runs
Lists test runs submitted in your organization. The response is an array of objects, each keyed by testRunId with details and status of each test run.
GET https://{{host}}/test-management/v3/test-runs/:testRunId
Returns details of a test run. Check Functional testing results to learn how to analyze the results.
4. Test runs - Get test run's detailed results
GET https://{{host}}/test-management/v3/test-runs/:testRunId/raw-request-response
Gets a raw request and response for all URLs in a test run.
5. Test suites - Create a test suite
POST https://{{host}}/test-management/v3/functional/test-suites
Creates an empty test suite. To add objects to the newly created test suite, run the Add test cases to a test suite and Add variables to a test suite operations.
6. Test suites - List test suites
GET https://{{host}}/test-management/v3/functional/test-suites
Lists test suites created in your organization. The list can also include deleted test suites you can restore. The response contains an array of objects, each keyed by testSuiteId. You can use these IDs to Get a test suite with child objects.
7. Test suites - Generate a test suite with child objects
POST https://{{host}}/test-management/v3/functional/test-suites/auto-generate
Generates a default test suite with test cases and variables for a specific property version and a URL. Based on property settings and its behaviors and the URL, Test Center generates a default test suite object with test cases and variables. You can modify the generated test suite and add it to Test Center using the Create a test suite with child objects operation.
8. Test suites - Create a test suite with child objects
POST https://{{host}}/test-management/v3/functional/test-suites/with-child-objects
Creates a test suite with test cases and variables. You can use the Generate a test suite with child objects operation to create a default test suite for a property version and then import it with this operation. The operation responds with a partial-success 207 response. Once you create the test suite, you can continue adding more objects to it with the Add test cases to a test suite and Add variables to a test suite operations.
9. Test suites - Get a test suite
GET https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId
Returns basic data about a test suite. To check test cases and variables included in the test suite, run the Get a test suite with child objects operation.
10. Test suites - Update a test suite
PUT https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId
Updates basic settings of a test suite. To edit test cases and variables, run the Update a test suite with child objects operation.
11. Test suites - Delete a test suite
DELETE https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId
Deletes a test suite and included child objects: test cases and variables. You can restore test suites with child objects within 30 days of deleting them.
12. Test suites - Restore a test suite
POST https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/restore
Restores a deleted test suite and included child objects. You can run this operation within 30 days of deleting the test suite.
13. Test suites - Get a test suite with child objects
GET https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/with-child-objects
Exports a test suite with test cases and variables.
14. Test suites - Update a test suite with child objects
PUT https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/with-child-objects
Updates a test suite and included test cases and variables.
15. Variables - Add variables to a test suite
POST https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/variables
Adds new variables to a test suite. You can use variables in a test request's URL or request headers and in condition expression, as a substitute of placeholders. To learn more, see Variables. The operation responds with a partial-success 207 response.
16. Variables - List variables
GET https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/variables
Lists variables created in a test suite.
17. Variables - Update variables
PUT https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/variables
Updates variables in a test suite. The operation responds with a partial-success 207 response.
18. Variables - Delete variables
POST https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/variables/remove
Deletes unused variables from a test suite. The operation responds with a partial-success 207 response.
19. Variables - Get a variable
GET https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/variables/:variableId
Returns details of a variable used in a test suite.
20. Test cases - Add test cases to a test suite
POST https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/test-cases
Adds a list of new functional test cases to a test suite. Each test case consists of a test request, client profile, and condition. If you want to use variables within a condition or test request's URL or request header, create the needed variables first. The operation responds with a partial-success 207 response.
21. Test cases - List test cases
GET https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/test-cases
Lists functional test cases included in a test suite. The list can also include deleted test cases that you can restore. The response is an array of objects, each keyed by testCaseId.
22. Test cases - Update test cases
PUT https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/test-cases
Updates functional test cases in a test suite. The operation responds with a partial-success 207 response.
23. Test cases - Reorder test cases in a test suite
PUT https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/test-cases/order
Reorders functional test cases in a test suite. The order of test cases applies when running a test for stateful test suites. You need to provide target order for all test cases included in a test suite. To check the current order of test cases, run the Get a test suite with child objects operation.
24. Test cases - Remove test cases
POST https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/test-cases/remove
Removes functional test cases with specific identifiers from a test suite. To get the identifiers, run the List test cases operation. The operation responds with a partial-success 207 response.
25. Test cases - Restore test cases
POST https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/test-cases/restore
Restores functional test cases into a test suite. To get the testCaseId of the test case you want to restore, run the List test cases operation with includeRecentlyDeleted set to true. The operation responds with a partial-success 207 response.
26. Test cases - Get a test case
GET https://{{host}}/test-management/v3/functional/test-suites/:testSuiteId/test-cases/:testCaseId
Returns details of a functional test case.
27. Test catalog template - Get the test catalog template
GET https://{{host}}/test-management/v3/functional/test-catalog/template
Returns the test catalog template used for creating conditions. To learn more, see Test Center concepts and Example: create a condition.
28. Test conditions - List test conditions
GET https://{{host}}/test-management/v3/functional/test-catalog/conditions
Lists condition statements you can use for creating test cases.
29. Test requests - List test requests
GET https://{{host}}/test-management/v3/functional/test-requests
Lists test requests created in your organization.
30. Functions - Check how functions work
POST https://{{host}}/test-management/v3/functional/functions/try-it
Runs a created function on sample data to check whether it returns the expected value. A function is valid for use in a test case if the response's results value returns only one value. To learn more about functions and variables, see Variables.
ENDPOINTS