Meta Data

Storing additional data, or "meta data", with a build file can provide valuable context for your automated tests, especially when dealing with multiple environments or specific feature branches. Meta data can be passed during the build upload process and then propagated through various aspects of the test lifecycle, such as in test reports and webhook payloads.

Why Pass Meta Data?

• Environment Context: Differentiate between various deployment environments, e.g. development, staging, etc.

• Branch Information: Identify the specific feature branch associated with the build.

• Additional Notes: Provide extra information, such as developer notes, versioning, or other relevant data.

Passing Meta Data through the uploadBuild Endpoint

Meta data should be passed as a JSON object to the uploadBuild endpoint. Ensure your data is structured appropriately and is relevant to your testing objectives.

API Endpoint Documentation

For more details on using the API endpoint, refer to our uploadBuild Endpoint Documentation.

Example Usage

Here’s a simple example to illustrate how you might pass meta data when interacting with the uploadBuild endpoint:

Shell

curl -i -X POST \
    -H "Content-Type: multipart/form-data" \
    -F "build=@<build_file_path>" \
    -F "organisation_key=<ORG_KEY>" \
    -F "platform=<platform>" \
    -F "metadata={ \"branch\": \"feature-login\" }" \
    https://api.mobileboost.io/uploadBuild/