lookup_builds
Retrieve build summaries with filters like status, time range, and name. Obtain build IDs needed for further API calls.
Instructions
Queries the requesting account and returns a summary of each build matching the query, including the ID value,
which may be a required parameter of other API calls related to a specific build. You can narrow the results of
your query using any of the optional filtering parameters.
:param build_source: The type of device for which you are getting builds. Valid values are: 'rdc' - Real Device
Builds, 'vdc' - Emulator or Simulator Builds
:param user_id: Optional. Returns any builds owned by the specified user that the authenticated user is authorized to view. You can look up the IDs of users in your organization using the Lookup Users endpoint.
:param org_id: Optional. Returns all builds in the specified organization that the authenticated user is authorized to view.
:param group_id: Optional. Returns all builds associated with the specified group that the authenticated user is authorized to view.
:param team_id: Optional. Returns all builds for the specified team that the authenticated user is authorized to view.
:param status: Optional. Returns only builds where the status matches the list of values specified. Valid values are: running - Any job in the build has a state of running, new, or queued. error - The build is not running and at least one job in the build has a state of errored. failed - The build is not running or error and at least one job in the build has a state of failed. complete - The build is not running, error, or failed, but the number of jobs with a state of finished does not equal the number of jobs marked passed, so at least one job has a state other than passed. success -- All jobs in the build have a state of passed.
:param start: Optional. Returns only builds where the earliest job ran on or after this Unix timestamp. Note: If experiencing errors, try providing both start and end parameters together.
:param end: Optional. Returns only builds where the latest job ran on or before this Unix timestamp. Note: If experiencing errors, try providing both start and end parameters together.
:param limit: Optional. The maximum number of builds to return in the response.
:param name: Optional. Returns builds with a matching build name.
:param offset: Optional. Begins the set of results at this index number.
:param sort: Optional. Sorts the results in alphabetically ascending or descending order. Valid values are: asc - Ascending desc - Descending
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| build_source | Yes | ||
| user_id | No | ||
| org_id | No | ||
| group_id | No | ||
| team_id | No | ||
| status | No | ||
| start | No | ||
| end | No | ||
| limit | No | ||
| name | No | ||
| offset | No | ||
| sort | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |