Define custom ID for test-suite

On every test-suite upload, a new value for test_url is generated. You need to use this value to execute your XCUI tests with the latest build of your XCUI test-suite.

If you want to use a constant value to specify the test-suite and don’t want to modify your scripts after every build upload, you can define a custom ID for your test-suite. Use the same custom ID every time you upload a new build of the test-suite. Here is an example cURL request to upload an XCUI test-suite with the custom ID defined as SampleTest :

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/test-suite" \
-F "file=@/path/to/app/file/application-debug-test.zip" \
-F "custom_id=SampleTest"

A sample response to the above API request is shown below :

 {
    "test_url":"bs://f7c874f21852ba57957a3fdc33f47514288c4ba4", 
    "custom_id":"SampleTest",
    "shareable_id":"exampleuser/SampleTest"
 }

While executing your XCUI tests, simply use the custom_id value (SampleTest in the above example) to specify the XCUI test-suite. The test execution will pick the last uploaded build corresponding to that custom ID.

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.