Specify test-suite

While executing your XCUI tests, you must specify the uploaded test-suite that contains your XCUI test cases. In order to do so, you need to pass the testSuite parameter in the REST API request to start your test execution. You can set its value in one of the following ways :

1. Using a test_url value: This is returned in the response to a test-suite upload REST API request.
2. Using a custom_id value: This is the custom ID you defined in a test-suite upload REST API request. By default, it will pick the last build of your uploaded test-suite under the given custom ID.
3. Using a shareable_id value: This is returned in the response to a test-suite upload REST API request. It enables other users in your organization to test using your uploaded test-suite.

REST API endpoint :

POST /app-automate/xcuitest/v2/build

Example cURL requests :

Use a sample test_url to specify the test-suite for your XCUI test execution :

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build" \
-d '{"devices": ["iPhone 8-11"], "app": "bs://f7c874f21852ba57957a3fdc33f47514288c4ba4", "testSuite": "bs://e994db8333e32a5863938666c3c3491e778352ff"}' \
-H "Content-Type: application/json"

Use sample custom_id to specify the test-suite in your XCUI test execution :

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build" \
-d '{"devices": ["iPhone 8-11"], "app": "SampleApp", "testSuite": "SampleTest"}' \
-H "Content-Type: application/json"

Related topics

• Manage your uploaded app or test suite using our upload app REST API and upload test suite REST API.

• Use the get app API endpoint and list test suites API endpoint to list your recently uploaded apps and test suites.

• Delete your uploaded app or test suite using the delete app API endpoint and delete test suite API endpoint.