Organize tests
You can logically group multiple XCUI test executions under a single project. This helps you easily access all related test executions on the App Automate dashboard and also while fetching test results using REST API.
In order to group XCUI test executions under a given project, you need to pass the project parameter in the REST API request to start your test execution. You can set its value as shown in the table below.
REST API endpoint :
POST /app-automate/xcuitest/v2/build
| Parameter | Description | Values |
|---|---|---|
project |
A unique identifier to logically group multiple test executions together | String Only letters (A-Z, a-z), digits (0-9), periods (.), colons (:), hiphens (-), square brackets ([]), forward slashes (/), asperands (@), ampersands (&), single quotes (‘), and underscores (_) are allowed. Default: Untitled Project |
buildTag |
A custom tag for your builds | String Only letters (A-Z, a-z), digits (0-9), periods (.), colons (:), hiphens (-), square brackets ([]), forward slashes (/), asperands (@), ampersands (&), single quotes (‘), and underscores (_) are allowed. Any other characters are ignored. Any other characters are ignored. |
Example cURL requests :
Both the test executions shown below specify the same value for the project parameter. Accordingly, they will be grouped together under the same project Dashboard-v2
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build" \
-d '{"project" : "Dashboard-v2", "devices": ["iPhone 8 Plus-11.0"], "app": "bs://f5L3azt9pLzE995f49376eb1fa3c284dc321f8d", "testSuite": "bs://6eb1fa3c284ddbe9971b2d1aee0d52943b9c081"}' \
-H "Content-Type: application/json"
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build" \
-d '{"project" : "Dashboard-v2", "devices": ["iPhone 8 Plus-11.0"], "app": "bs://f5L3azt9pLzE995f49376eb1fa3c284dc321f8d", "testSuite": "bs://aee0d52943dbe9971b2d1a2943be43b9c081"}' \
-H "Content-Type: application/json"
Adding build tags
You can add a custom build tag to your builds using the buildTag capability. You can filter your builds according to the assigned tag on the App Automate dashboard.
Example cURL requests :
The following code shows how the buildTag capability is used to add a build tag:
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/xcuitest/v2/build" \
-d '{"project" : "Dashboard-v2", "devices": ["Samsung Galaxy S10-9.0"], "app": "bs:/12474f21852ba5233fdc33f47514288c4ba4", "testSuite": "bs://e994db8333e32a5863938666c3c3491e1231", "networkLogs": "false", "disableAnimations": "true", "deviceLogs": "true", "video": "true", "project": "Sanity", "buildTag": "Laser Tag"}' \
-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.
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
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!
