QMetry: Fetch Platforms
qmetry_fetch_platformsRetrieve QMetry platform records from a project, using filters, sorting, and pagination, to get metadata for test execution planning and environment selection.
Instructions
Fetch QMetry platforms from the current project
Toolset: Projects
Parameters:
projectKey (string): Project key - unique identifier for the project (default: "default")
start (number): Start index for pagination - defaults to 0 (default: 0)
page (number): Page number to return (starts from 1) (default: 1)
limit (number): Number of records (default 10). (default: 10)
sort (string): Sort criteria as JSON string (default '[{"property":"platformID","direction":"DESC"}]') (default: "[{"property":"platformID","direction":"DESC"}]")
filter (string): Filter criteria as JSON string (default '[]') (default: "[]")
Output Description: JSON object with platforms list and pagination metadata
Use Cases: 1. Fetch all platforms from the current project 2. Get platform metadata for test execution planning 3. List platforms for test environment selection 4. Filter platforms by name or properties 5. Get paginated platform results for large projects 6. Retrieve platform information for cross-platform testing 7. Search for specific platforms using filters 8. Get platform details for test execution assignment
Examples:
Get all platforms (default behavior)
{}Expected Output: List of all platforms with default pagination (10 items per page)
Get platforms with custom pagination
{
"page": 1,
"limit": 10,
"start": 0
}Expected Output: List of platforms with custom pagination settings
Filter platforms by name
{
"filter": "[{\"value\":\"Chrome\",\"type\":\"string\",\"field\":\"name\"}]"
}Expected Output: Filtered list of platforms matching the name criteria
Filter platforms by archive status
{
"filter": "[{\"value\":[1,0],\"type\":\"list\",\"field\":\"isArchived\"}]"
}Expected Output: List of platforms filtered by archive status (archived and non-archived)
Get only archived platforms
{
"filter": "[{\"value\":[1],\"type\":\"list\",\"field\":\"isArchived\"}]"
}Expected Output: List of only archived platforms
Get only active/non-archived platforms
{
"filter": "[{\"value\":[0],\"type\":\"list\",\"field\":\"isArchived\"}]"
}Expected Output: List of only active/non-archived platforms
Get platforms with custom sorting
{
"sort": "[{\"property\":\"name\",\"direction\":\"ASC\"}]"
}Expected Output: List of platforms sorted by name in ascending order
Hints: 1. Use 'default' project key when user doesn't specify one 2. Default pagination: start=0, page=1, limit=10 3. Filter parameter should be a JSON string with filter criteria 4. Sort parameter should be a JSON string with sort criteria 5. Default sort: platformID descending 6. Common filter fields: 'name' (string), 'isArchived' (list of 0,1) for archive status 7. IMPORTANT: Always use 'isArchived' field for filtering by archive status, even though response shows 'isPlatformArchived' 8. Archive status values: 0 = active/non-archived, 1 = archived 9. Empty payload {} is sent when no parameters are provided 10. Use platforms for cross-platform testing and environment selection
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number to return (starts from 1) | |
| sort | No | Sort criteria as JSON string (default '[{"property":"platformID","direction":"DESC"}]') | [{"property":"platformID","direction":"DESC"}] |
| limit | No | Number of records (default 10). | |
| start | No | Start index for pagination - defaults to 0 | |
| filter | No | Filter criteria as JSON string (default '[]') | [] |
| projectKey | No | Project key - unique identifier for the project | default |