Skip to main content
Transform your testing process with: Real Device Features, Company-wide Licences, & App Percy

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.

  • Other users in your team can test an app uploaded by you. They need to use the shareable_id value to specify the application under test while setting the app capability in their tests.
  • The use of custom ID or shareable ID is optional.
  • The maximum character limit in the custom_id parameter is 100 and the characters allowed are a-z, A-Z, 0-9, period(.), underscore(_), and hyphen(-).

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Download Copy