1.8.3npm · jira-qmetry-mcp-server · current release
Observed 2026-08-22T23:29:50.508Z using mcpSecurity-inventory. Status: succeeded. Negotiated protocol: 2025-06-18.
{
"tools": {
"listChanged": true
}
}| Tool | Category | Annotations | Risk |
|---|---|---|---|
add-test-case-versionCreate a new version of an existing test caseInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of Test Case. Refer id from the response of API \"Search Test Case\"."
},
"copyFromVersion": {
"type": "number",
"description": "Test Case Version No. Create new testcase version from existing given test case version no."
},
"fields": {
"type": "object",
"properties": {
"assignee": {
"type": "string",
"description": "Jira user Account ID"
},
"description": {
"type": "string",
"description": "Description of Test Case"
},
"precondition": {
"type": "string",
"description": "Precondition of Test Case"
},
"estimatedTime": {
"type": "string",
"description": "Pass string in HH:MM:SS format."
},
"folderId": {
"type": "number",
"description": "Refer id from the response of API \"Get test case folders\"."
},
"labels": {
"type": "array",
"items": {
"type": "number"
},
"description": "Array of label Ids,Refer id from the response of API \"Get labels\"."
},
"priority": {
"type": "number",
"description": "Refer id from the response of API \"Get Priorities\"."
},
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"reporter": {
"type": "string",
"description": "Jira user Account ID"
},
"status": {
"type": "number",
"description": "Refer id from the response of API \"Get Test Case Status\"."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"stepDetails": {
"type": "string",
"description": "Description of the test step"
},
"testData": {
"type": "string",
"description": "Test data required for the step"
},
"expectedResult": {
"type": "string",
"description": "Expected result of the step"
}
},
"required": [
"stepDetails",
"testData",
"expectedResult"
],
"additionalProperties": false
},
"description": "Array of test steps"
},
"summary": {
"type": "string",
"description": "Name of Test Case."
},
"isAutomated": {
"type": "boolean",
"description": "Whether testcase is automated or not - true or false"
},
"withRequirements": {
"type": "boolean",
"description": "If true then it will copy linked stories of the previous version to the newer version."
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields JSON object with field IDs as keys. Refer to \"Get Test Case Custom Fields\" to get available custom fields."
}
},
"additionalProperties": false,
"description": "Refer Fields Reference Table if the user wants to override existing data in the newly created version."
}
},
"required": [
"id",
"copyFromVersion"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
archive-qmetry-test-caseArchive a test caseInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
archive-qmetry-test-cycleArchive a test cycleInput schema{
"type": "object",
"properties": {
"idOrKey": {
"type": "string",
"description": "Refer id or key from the response of API \"Search Test Cycles\""
}
},
"required": [
"idOrKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
archive-qmetry-test-planArchive a test planInput schema{
"type": "object",
"properties": {
"idOrKey": {
"type": "string",
"description": "Test Plan Id, refer id from response of API \"search Test Plans\""
}
},
"required": [
"idOrKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
clone-qmetry-test-caseClone a test case with optional configurationsInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
},
"summary": {
"type": "string",
"description": "Summary to set in cloned Test Case."
},
"folderId": {
"type": "number",
"description": "Refer id from the response of API \"Get test case folders\"."
},
"version": {
"type": "string",
"description": "Test Case Version Number which want to clone. Pass \"*\" if want to clone all test case versions. Refer versionNo from the response of API \"Get Test Case version details\"."
},
"withComments": {
"type": "boolean",
"description": "If true then all test case comments will get cloned."
},
"withAttachments": {
"type": "boolean",
"description": "If true then all attachments gets cloned."
},
"requirementToLink": {
"type": "number",
"description": "JIRA Issue Id which want to link with cloned test case."
},
"withRequirements": {
"type": "boolean",
"description": "If true testcase will get cloned and the linkage with associated stories will preserve."
}
},
"required": [
"id",
"summary"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
copy-qmetry-test-caseCopy a Qmetry test case from one folder to another folderInput schema{
"type": "object",
"properties": {
"testcaseIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the test cases to move. Refer id from the response of API \"Get test cases\"."
},
"targetFolderId": {
"type": "number",
"description": "The ID of the destination folder. Refer id from the response of API \"Get test case folders\"."
},
"projectId": {
"type": "number",
"description": "The ID of the project containing the test case. Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"selectedFolderId": {
"type": "number",
"description": "The ID of the folder to move the test cases from. Refer id from the response of API \"Get test case folders\"."
}
},
"required": [
"testcaseIds",
"targetFolderId",
"projectId",
"selectedFolderId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
copy-qmetry-test-case-folderCopy a Qmetry test case folder and optionally its contents to another locationInput schema{
"type": "object",
"properties": {
"folderId": {
"type": "string",
"description": "Refer id from the response of API \"Get test case folders\"."
},
"projectId": {
"type": "string",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"newParentId": {
"type": "string",
"description": "Folder Id of where you want to copy the folder.Refer id from the response of API \"Get test case folders\"."
}
},
"required": [
"folderId",
"projectId",
"newParentId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-labelCreate a new label in a Qmetry projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"name": {
"type": "string",
"description": "Name of Label"
}
},
"required": [
"projectId",
"name"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-caseCreate a Qmetry test caseInput schema{
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "Name of Test Case."
},
"projectId": {
"type": "string",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"folderId": {
"type": "string",
"description": "Refer id from the response of API \"Get test case folders\". If you want to create a folder at the root level, pass \"-1\"."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"stepDetails": {
"type": "string",
"description": "Description of the test step"
},
"testData": {
"type": "string",
"description": "Test data required for the step"
},
"expectedResult": {
"type": "string",
"description": "Expected result of the step"
},
"id": {
"type": "number",
"description": "Unique identifier for the step"
},
"isChecked": {
"type": "boolean",
"default": false,
"description": "Whether the step is checked/completed"
},
"isExpanded": {
"type": "boolean",
"default": true,
"description": "Whether the step is expanded in the UI"
}
},
"required": [
"stepDetails",
"testData",
"expectedResult",
"id"
],
"additionalProperties": false
},
"description": "Array of test steps with details, test data, and expected results"
},
"assignee": {
"type": "string",
"description": "Jira user Account ID"
},
"components": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of component Id and for componentId refer id from the response of API \"Get components\"."
},
"description": {
"type": "string",
"description": "Description of Test Case"
},
"precondition": {
"type": "string",
"description": "Precondition of Test Case"
},
"estimatedTime": {
"type": "string",
"description": "Pass string in HH:MM:SS format."
},
"fixVersions": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of JIRA fix version ID"
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of label Ids,Refer id from the response of API \"Get labels\"."
},
"priority": {
"type": "string",
"description": "Refer id from the response of API \"Get Priorities\"."
},
"reporter": {
"type": "string",
"description": "Jira user Account ID"
},
"sprint": {
"type": "string",
"description": "Jira sprint ID"
},
"status": {
"type": "string",
"description": "Refer id from the response of API \"Get Test Case Status\"."
},
"isAutomated": {
"type": "boolean",
"description": "Whether testcase is automated or not - true or false"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields JSON object with field IDs as keys. Refer to \"Get Test Case Custom Fields\" to get available custom fields."
}
},
"required": [
"summary",
"projectId",
"folderId",
"steps"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-case-folderCreate a Qmetry test case folder for a given project keyInput schema{
"type": "object",
"properties": {
"folderName": {
"type": "string",
"description": "Name of Folder"
},
"description": {
"type": "string",
"description": "Description of Folder"
},
"parentId": {
"type": "string",
"description": "Refer id from the response of API \"Get test case folders\". If you want to create a folder at the root level, pass \"-1\"."
},
"projectId": {
"type": "string",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
}
},
"required": [
"folderName",
"parentId",
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-case-statusCreate a new test case status in QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"name": {
"type": "string",
"description": "Name of the status to create."
},
"color": {
"type": "string",
"description": "Status Color Ex. Hex code of color, refer JSON schema"
},
"description": {
"type": "string",
"description": "Description of the status."
}
},
"required": [
"projectId",
"name",
"color"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-cycleCreate a new test cycleInput schema{
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "Test Cycle Summary"
},
"projectId": {
"type": "string",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\""
},
"folderId": {
"type": "number",
"description": "Refer id from the response of API \"Get Test Cycle folders\""
},
"priority": {
"type": "number",
"description": "Refer id from the response of API \"Get Priorities\""
},
"status": {
"type": "number",
"description": "Refer id from the response of API \"Get Test Cycle Status\""
},
"reporter": {
"type": "string",
"description": "Pass Jira user account uuid to assign reporter"
},
"labels": {
"type": "array",
"items": {
"type": "number"
},
"description": "Refer ids from the response of API \"Get Labels\". Will be sent as {add: [labelId1, ...]} to API"
},
"testCasesToLink": {
"type": "string",
"description": "Either list of test case Ids or search filter query"
},
"description": {
"type": "string",
"description": "Test Cycle description"
},
"plannedStartDate": {
"type": "string",
"description": "Enter in format dd/MMM/yyyy HH:mm. Example: 18/Oct/2025 09:00"
},
"plannedEndDate": {
"type": "string",
"description": "Enter in format dd/MMM/yyyy HH:mm. Example: 25/Oct/2025 17:00"
},
"actualTime": {
"type": "number",
"description": "Enter value in milliseconds"
},
"isAutomated": {
"type": "boolean",
"description": "Whether test cycle is automated or not - true or false"
},
"assignee": {
"type": "string",
"description": "Pass Jira user account uuid to assign test cycle"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields as array of objects with id and value. Refer to \"Get Test Cycle Custom Fields\" to get available custom fields."
}
},
"required": [
"summary",
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-cycle-folderCreate a Qmetry test cycle folder for a given projectInput schema{
"type": "object",
"properties": {
"folderName": {
"type": "string",
"description": "Name of Folder"
},
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"parentId": {
"type": "number",
"description": "Refer id from the response of API \"Get test cycle folders\".If you want to create a folder at the root level, pass \"-1\"."
},
"description": {
"type": "string",
"description": "Description of Folder"
}
},
"required": [
"folderName",
"projectId",
"parentId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-cycle-statusCreate a new test cycle status in QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"name": {
"type": "string",
"description": "Status name"
},
"color": {
"type": "string",
"description": "Status Color Ex. Hex code of color, refer JSON schema"
},
"description": {
"type": "string",
"description": "Status Description"
}
},
"required": [
"projectId",
"name",
"color"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-planCreate a new test planInput schema{
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "Test Plan Summary"
},
"projectId": {
"type": "string",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\""
},
"folderId": {
"type": "number",
"description": "Refer id from the response of API \"Get Test Plan folders\""
},
"priority": {
"type": "number",
"description": "Refer id from the response of API \"Get Priorities\""
},
"status": {
"type": "number",
"description": "Refer id from the response of API \"Get Test Plan Status\""
},
"reporter": {
"type": "number",
"description": "Pass Jira user account uuid to assign reporter"
},
"labels": {
"type": "array",
"items": {
"type": "number"
},
"description": "Refer ids from the response of API \"Get Labels\". Will be sent as {add: [labelId1, labelId2, ...]} to API"
},
"testcycles": {
"type": "object",
"properties": {
"testcycleIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of test cycle IDs"
}
},
"required": [
"testcycleIds"
],
"additionalProperties": false,
"description": "Test cycles to link. Format: {testcycleIds: [\"id1\", \"id2\"]}"
},
"description": {
"type": "string",
"description": "Test Plan description"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields as array of objects with id and value. Refer to \"Get Test Plan Custom Fields\" to get available custom fields."
}
},
"required": [
"summary",
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-plan-folderCreate a Qmetry test plan folder for a given projectInput schema{
"type": "object",
"properties": {
"folderName": {
"type": "string",
"description": "Name of the folder"
},
"description": {
"type": "string",
"description": "Description of the folder"
},
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"parentId": {
"type": "number",
"description": "Refer id from the response of API \"Get test plan folders\".If you want to create a folder at the root level, pass \"-1\"."
}
},
"required": [
"folderName",
"projectId",
"parentId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-plan-statusCreate a new test plan status in QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"name": {
"type": "string",
"description": "Status name"
},
"color": {
"type": "string",
"description": "Status Color Ex. Hex code of color, refer JSON schema"
},
"description": {
"type": "string",
"description": "Status Description"
}
},
"required": [
"projectId",
"name",
"color"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
create-qmetry-test-stepCreate a Qmetry test step for a given test caseInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
},
"no": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"stepDetails": {
"type": "string",
"description": "Test step Details"
},
"testData": {
"type": "string",
"description": "Test step expected Result"
},
"expectedResult": {
"type": "string",
"description": "Test step test data"
}
},
"required": [
"stepDetails",
"testData",
"expectedResult"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"no",
"steps"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
delete-qmetry-labelDelete a label from a Qmetry projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"labelId": {
"type": "number",
"description": "Refer id from the response of API \"Get labels\"."
}
},
"required": [
"projectId",
"labelId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
delete-qmetry-test-case-statusDelete a test case status from QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"statusId": {
"type": "number",
"description": "Refer id from the response of API \"Get statuses\"."
}
},
"required": [
"projectId",
"statusId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
delete-qmetry-test-cycle-statusDelete a test cycle status from QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"statusId": {
"type": "number",
"description": "Refer id from the response of API \"Get test cycle statuses\"."
}
},
"required": [
"projectId",
"statusId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
delete-qmetry-test-plan-statusDelete a test plan status from QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"statusId": {
"type": "number",
"description": "Refer id from the response of API \"Get test plan statuses\"."
}
},
"required": [
"projectId",
"statusId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
delete-qmetry-test-stepDelete a Qmetry test step for a given test caseInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
},
"no": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
},
"stepIds": {
"type": "array",
"items": {
"type": "number"
},
"description": "Refer id from the response of API \"Get Test Steps\"."
}
},
"required": [
"id",
"no",
"stepIds"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
delete-test-case-versionDelete a specific test case versionInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
},
"no": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
}
},
"required": [
"id",
"no"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
edit-qmetry-test-case-folderEdit a Qmetry test case folder for a given project keyInput schema{
"type": "object",
"properties": {
"folderName": {
"type": "string",
"description": "Name of Folder"
},
"description": {
"type": "string",
"description": "Description of Folder"
},
"folderId": {
"type": "string",
"description": "Refer id from the response of API \"Get test case folders\"."
},
"projectId": {
"type": "string",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
}
},
"required": [
"folderName",
"folderId",
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
edit-qmetry-test-cycle-folderEdit a Qmetry test cycle folder for a given projectInput schema{
"type": "object",
"properties": {
"folderName": {
"type": "string",
"description": "Name of Folder"
},
"description": {
"type": "string",
"description": "Description of Folder"
},
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get test cycle folders\"."
},
"folderId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
}
},
"required": [
"folderName",
"projectId",
"folderId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
edit-qmetry-test-plan-folderEdit a Qmetry test plan folder for a given projectInput schema{
"type": "object",
"properties": {
"folderName": {
"type": "string",
"description": "New name of the folder"
},
"description": {
"type": "string",
"description": "New description of the folder"
},
"folderId": {
"type": "number",
"description": "ID of the folder to update."
},
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
}
},
"required": [
"folderName",
"folderId",
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-custom-field-typesGet all custom field types supported in QMetryInput schema{
"type": "object",
"properties": {},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-label-reference-countGet Qmetry label reference count for a given projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"labelId": {
"type": "number",
"description": "Refer id from the response of API \"Get labels\"."
}
},
"required": [
"projectId",
"labelId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-labelsGet Qmetry labels for a given project with optional filtering and paginationInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-linked-test-casesGet all test cases linked to a specific requirement (Jira issue) in QmetryInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Jira Requirement Id. Example: \"10000\""
},
"fields": {
"type": "string",
"default": "summary,priority,status",
"description": "Fields to be fetched. Multiple comma separated values also possible. Example: \"fixVersions\""
},
"sort": {
"type": "string",
"description": "Pattern fieldName:order, eg: key:asc"
},
"startAt": {
"type": "number",
"description": "default 0"
},
"maxResults": {
"type": "number",
"description": "Default 50, Max 100"
},
"filter": {
"type": "object",
"additionalProperties": {},
"description": "Filter results by fields"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-prioritiesGet Qmetry priorities for a given projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "The ID of the project."
},
"status": {
"type": "string",
"description": "The status of the priority."
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-priority-reference-countGet Qmetry priority reference count for a given projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"priorityId": {
"type": "number",
"description": "Refer id from the response of API \"Get Priorities\"."
}
},
"required": [
"projectId",
"priorityId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-projectsGet all Qmetry projectsInput schema{
"type": "object",
"properties": {
"projectName": {
"type": "string",
"description": "The name of the project to search for"
},
"maxResults": {
"type": "number",
"description": "Maximum number of results to return"
},
"startAt": {
"type": "number",
"description": "Starting index for pagination"
}
},
"required": [
"projectName"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-te-custom-fieldsGet all test execution custom field detailsInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-case-custom-fieldsGet all test case custom field detailsInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-case-foldersGet all Qmetry test case folders for a given project keyInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"short": {
"type": "string",
"description": "Possible values - NAME,CREATED_ON,UPDATED_ON Pattern - sortField:sortOrder(asc/desc) For example if want to sorting on createOn in ascending order then need to pass CREATED_ON:asc"
},
"withCount": {
"type": "boolean",
"description": "Show count of testCases associated with Folder"
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-case-statusesGet Qmetry test case statuses for a given project with optional filtering and paginationInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"status": {
"type": "string",
"description": "Possible values are active, archive. Ex. status=active,archive"
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-cycleGet details of a specific test cycleInput schema{
"type": "object",
"properties": {
"idOrKey": {
"type": "string",
"description": "Test Cycle Id or Test Cycle Key"
},
"fields": {
"type": "string",
"description": "Comma separated field names to be fetched. Allowed: id,key,summary,description,projectId,folder,created,updated,labels,priority,status,assignee,reporter,isRebuildSeqNotRequired,automationRule"
}
},
"required": [
"idOrKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-cycle-custom-fieldsGet all existing test cycle custom field detailsInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-cycle-foldersGet Qmetry test cycle folders for a given projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"sort": {
"type": "string",
"description": "Possible values - NAME,CREATED_ON,UPDATED_ONPattern - sortField:sortOrder(asc/desc) For example if want to sorting on createOn in ascending order then need to pass CREATED_ON:asc"
},
"withCount": {
"type": "boolean",
"description": "Show count of test cycles associated with Folder"
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-cycle-linked-defectsGet all defects linked to test cycle executions with pagination and filtering supportInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer keyId from the response of API \"Get Test Cycle\""
},
"startAt": {
"type": "number",
"description": "Refer Parameters"
},
"maxResults": {
"type": "number",
"description": "Refer Parameters"
},
"fields": {
"type": "string",
"description": "Refer Parameters"
},
"sort": {
"type": "string",
"description": "Refer Parameters"
},
"filter": {
"type": "object",
"additionalProperties": {},
"default": {},
"description": "Filter defects using fields: searchText (text in summary/issue key), status (defect status name), priority (defect priority name), testCaseKey (from Search Test Cases), environment (from Get environment), executionResult (from Get execution result), build (execution build name), removeDuplicates (true to get unique defects), linkedBetweenDates (two comma separated dates in dd/MM/yyyy,dd/MM/yyyy format), executionLevel (TEST_STEP_EXECUTION, TEST_CASE_EXECUTION, ALL)"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-cycle-linked-test-casesGet test cases that are linked to a specific test cycle with pagination and filtering supportInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Cycle Id - Refer id from Search Test Cycles"
},
"startAt": {
"type": "number",
"default": 0,
"description": "Default 0"
},
"maxResults": {
"type": "number",
"default": 100,
"description": "Default 100, Max 100"
},
"fields": {
"type": "string",
"description": "Comma separated field names to be fetched",
"default": "id, key, summary, description, executionResult, status, priority, environment"
},
"sort": {
"type": "string",
"description": "Pattern fieldName:Order example id:asc",
"default": "key:asc"
},
"filter": {
"type": "object",
"additionalProperties": {},
"description": "Filter by fields to filter search results"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-cycle-statusesGet Qmetry test cycle statuses for a given project with optional filteringInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"status": {
"type": "string",
"description": "Possible values are active, archive. Ex. status=active,archive"
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-planGet details of a specific test plan by ID or KeyInput schema{
"type": "object",
"properties": {
"idOrKey": {
"type": "string",
"description": "Test Plan Id or Test Plan Key"
},
"fields": {
"type": "string",
"description": "Comma separated fields to be fetched, allowable fields are id, key, summary, description, projectId, folder, created, updated, labels, priority, status, reporter, testPlanFilterOperators"
}
},
"required": [
"idOrKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-plan-custom-fieldsGet custom field details for Test Plan ModuleInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-plan-foldersGet Qmetry test plan folders for a given projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"sort": {
"type": "string",
"description": "Possible values - NAME,CREATED_ON,UPDATED_ONPattern - sortField:sortOrder(asc/desc)For example if want to sorting on createOn in ascending order then need to pass CREATED_ON:asc"
},
"withCount": {
"type": "boolean",
"description": "Show count of test plans associated with Folder"
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-plan-statusesGet Qmetry test plan statuses for a given project with optional filteringInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"status": {
"type": "string",
"description": "Possible values are active, archive. Ex. status=active,archive"
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-qmetry-test-stepsGet Qmetry test steps for a given test caseInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
},
"no": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
},
"maxResults": {
"type": "number",
"description": "Refer parameters."
},
"sort": {
"type": "string",
"description": "Possible values - stepDetails,testData,seqNo,expectedResult Pattern - sortField:sortOrder(asc/desc) For example if want to sorting on sequence number in ascending order then need to pass seqNo:asc"
},
"startAt": {
"type": "number",
"description": "Refer parameters."
}
},
"required": [
"id",
"no"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-tc-custom-field-ref-countGet reference count for a particular test case custom fieldInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"id": {
"type": "string",
"description": "Refer id from the response of API \"Get custom fields\"."
}
},
"required": [
"projectId",
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-tcy-custom-field-ref-countGet test cycle references for a particular custom fieldInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"id": {
"type": "string",
"description": "Refer id from the response of API \"Get custom fields\"."
}
},
"required": [
"projectId",
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-te-custom-field-ref-countGet test execution reference count for a particular custom fieldInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get Test Execution Custom Fields\"."
},
"id": {
"type": "string",
"description": "Refer id from the response of API \"Get custom fields\"."
}
},
"required": [
"projectId",
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-test-case-status-ref-countGet the reference count of a test case status in QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"statusId": {
"type": "number",
"description": "Refer id from the response of API \"Get statuses\"."
}
},
"required": [
"projectId",
"statusId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-test-case-test-cyclesGet test cycles linked to a test caseInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
},
"tcVersionNo": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
},
"fields": {
"type": "string",
"description": "Comma separated fields to be fetched."
},
"startAt": {
"type": "number",
"description": "Default 0"
},
"maxResults": {
"type": "number",
"description": "Default 50, Max 100"
},
"sort": {
"type": "string",
"description": "Possible values - key,summary,estimatedTime,actualTime,status,priority,createdOn,updatedOn Pattern - sortField:sortOrder(asc/desc) For example if want to sorting on key in ascending order then need to pass key:asc"
}
},
"required": [
"id",
"tcVersionNo"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-test-case-version-detailsGet details of a specific test case versionInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
},
"no": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
},
"fields": {
"type": "string",
"description": "Comma separated fields to be fetched. Allowed: description,reporter,estimatedTime,labels,created,updated,executed,folders,passRateScore. Example: fixVersions"
}
},
"required": [
"id",
"no"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-test-case-versions-listGet list of all versions of a test caseInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-test-cycle-requirementsGet all requirements (stories) linked to a test cycleInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Cycle ID - Refer id from \"Search Test Cycles\""
},
"startAt": {
"type": "number",
"description": "Starting index for pagination (default 0)"
},
"maxResults": {
"type": "number",
"description": "Maximum results per page (default 50, max 100)"
},
"sort": {
"type": "string",
"description": "Sort pattern (e.g., key:asc). Possible values: key, status, priority"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-test-cycle-status-ref-countGet the reference count of a test cycle status in QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"statusId": {
"type": "number",
"description": "Refer id from the response of API \"Get test cycle statuses\"."
}
},
"required": [
"projectId",
"statusId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-test-cycle-test-plansGet all test plans linked to a test cycleInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Cycle ID - Refer id from \"Search Test Cycles\""
},
"startAt": {
"type": "number",
"description": "Starting index for pagination (default 0)"
},
"maxResults": {
"type": "number",
"description": "Maximum results per page (default 50, max 100)"
},
"fields": {
"type": "string",
"description": "Comma separated fields to be fetched"
},
"sort": {
"type": "string",
"description": "Sort field and order"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-test-plan-status-ref-countGet the reference count of a test plan status in QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"statusId": {
"type": "number",
"description": "Refer id from the response of API \"Get test plan statuses\"."
}
},
"required": [
"projectId",
"statusId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-test-plan-test-cyclesGet test cycles linked to a test planInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Plan Id, refer id from response of API \"search Test Plans\""
},
"startAt": {
"type": "number",
"description": "Default 0"
},
"maxResults": {
"type": "number",
"description": "Default 50, Max 100"
},
"fields": {
"type": "string",
"description": "Comma separated fields to be fetched, allowable fields are id, key, summary, description, projectId, folder, created, updated, labels, priority, status, reporter, testPlanFilterOperators"
},
"sort": {
"type": "string",
"description": "Pattern: sortField:order, Example: key:asc"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
get-tp-custom-field-ref-countGet test plan reference count for a particular custom fieldInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"id": {
"type": "string",
"description": "Refer id from the response of API \"Get custom fields\"."
}
},
"required": [
"projectId",
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
link-qmetry-requirementsLink one or more requirements (Jira issues) to a specific test case in QmetryInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the test case to link requirements to. Refer id from the response of API \"Search Test Case\"."
},
"no": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
},
"requirementIds": {
"type": "array",
"items": {
"type": "number"
},
"description": "List of JIRA Issue Id which want to link with given test case. Example: [123, 456]"
}
},
"required": [
"id",
"no",
"requirementIds"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
link-requirements-to-test-cycleLink requirements (stories) to a test cycle. If any requirement cannot be linked then it will come under warningMessages obj of response.Input schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Cycle ID - Refer id from \"Search Test Cycles\""
},
"requirementIds": {
"type": "array",
"items": {
"type": "number"
},
"description": "List of Jira Issue Id which want to link with given test cycle"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
link-test-case-to-test-cycleLink test cases to a test cycleInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Cycle ID - Refer id from \"Search Test Cycles\""
},
"testCases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Case ID"
},
"versionNo": {
"type": "number",
"description": "Test Case Version Number"
}
},
"required": [
"id",
"versionNo"
],
"additionalProperties": false
},
"description": "List of test cases to link. Example: [{id: \"AYjI5KPIZpxE\", versionNo: 1}]"
},
"sort": {
"type": "string",
"description": "Sort order for results"
}
},
"required": [
"id",
"testCases"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
link-test-cycles-to-test-planLink test cycles to a test planInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Plan Id, refer id from response of API \"search Test Plans\""
},
"testcycleIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of test cycles ids can be found using \"search test cycles\""
},
"sort": {
"type": "string",
"description": "\"sort\" field is added in request body whenever user selects across all pages to link"
}
},
"required": [
"id",
"testcycleIds"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
move-qmetry-test-caseMove a Qmetry test case from one folder to another folderInput schema{
"type": "object",
"properties": {
"testcaseIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the test cases to move. Refer id from the response of API \"Get test cases\"."
},
"targetFolderId": {
"type": "number",
"description": "The ID of the destination folder. Refer id from the response of API \"Get test case folders\"."
},
"projectId": {
"type": "number",
"description": "The ID of the project containing the test case. Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"selectedFolderId": {
"type": "number",
"description": "The ID of the folder to move the test cases from. Refer id from the response of API \"Get test case folders\"."
}
},
"required": [
"testcaseIds",
"targetFolderId",
"projectId",
"selectedFolderId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
move-qmetry-test-case-folderMove a Qmetry test case folder to a new parent folderInput schema{
"type": "object",
"properties": {
"folderId": {
"type": "string",
"description": "Refer id from the response of API \"Get test case folders\"."
},
"projectId": {
"type": "string",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"newParentId": {
"type": "string",
"description": "Folder Id of where you want to move the folder.Refer id from the response of API \"Get test case folders\"."
}
},
"required": [
"folderId",
"projectId",
"newParentId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
move-qmetry-test-cycleMove test cycles from one folder to another folderInput schema{
"type": "object",
"properties": {
"testcycleIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the test cycles to move"
},
"targetFolderId": {
"type": "number",
"description": "The ID of the destination folder. Refer id from the response of API \"Get Test Cycle folders\""
},
"projectId": {
"type": "number",
"description": "The ID of the project containing the test cycles. Refer id from the response of API \"Get QMetry Enabled Projects\""
}
},
"required": [
"testcycleIds",
"targetFolderId",
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
move-qmetry-test-cycle-folderMove a Qmetry test cycle folder to a new parent folderInput schema{
"type": "object",
"properties": {
"folderId": {
"type": "number",
"description": "Refer id from the response of API \"Get test cycle folders\"."
},
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"newParentId": {
"type": "number",
"description": "Folder Id of where you want to move the folder.Refer id from the response of API \"Get test cycle folders\"."
}
},
"required": [
"folderId",
"projectId",
"newParentId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
move-qmetry-test-plan-folderMove a Qmetry test plan folder to a new parent folderInput schema{
"type": "object",
"properties": {
"folderId": {
"type": "number",
"description": "Refer id from the response of API \"Get test plan folders\"."
},
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"newParentId": {
"type": "number",
"description": "Folder Id of where you want to move the folder.Refer id from the response of API \"Get test plan folders\"."
}
},
"required": [
"folderId",
"projectId",
"newParentId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
move-qmetry-test-plansMove test plans to another folderInput schema{
"type": "object",
"properties": {
"targetFolderId": {
"type": "number",
"description": "Folder Id where testplans to be moved"
},
"projectId": {
"type": "string",
"description": "Refer id from response of API \"Get Qmetry enabled projects\""
},
"testplanIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Refer id from response of API \"Search Test Plans\""
}
},
"required": [
"targetFolderId",
"projectId",
"testplanIds"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
search-qmetry-test-case-foldersSearch a Qmetry test case folder for a given projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"folderName": {
"type": "string",
"description": "Provide the actual folder name to search its details"
},
"mode": {
"type": "string",
"description": "Allowed value - \"STRICT\",if passed folder search will be absolute otherwise relative."
}
},
"required": [
"projectId",
"folderName"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
search-qmetry-test-casesSearch and list test cases according to filtersInput schema{
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"assignee": {
"type": "string",
"description": "Jira user Account ID"
},
"createdBy": {
"type": "string",
"description": "Jira user Account ID"
},
"createdOn": {
"type": "string",
"description": "Comma separated two dates. Pass in \"dd/MMM/yyyy,dd/MMM/yyyy\" date format."
},
"description": {
"type": "string",
"description": "Description of Test Case"
},
"estimatedTime": {
"type": "string",
"description": "Pass string in HH:MM:SS format"
},
"folderId": {
"type": "string",
"description": "Refer id from the response of API \"Get test case folders\""
},
"key": {
"type": "string",
"description": "Key of Test Case"
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of label names,Refer name from the response of API \"Get labels\"."
},
"priority": {
"type": "array",
"items": {
"type": "string"
},
"description": "Priority of the test case"
},
"reporter": {
"type": "string",
"description": "Jira user Account ID"
},
"status": {
"type": "array",
"items": {
"type": "string"
},
"description": "Refer name from the response of API \"Get Statuses\" for its module."
},
"summary": {
"type": "string",
"description": "Name of Test Case."
},
"updatedBy": {
"type": "string",
"description": "Jira user Account ID"
},
"updatedOn": {
"type": "string",
"description": "Comma separated two dates. Pass in \"dd/MMM/yyyy,dd/MMM/yyyy\" date format."
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields filter JSON object with field IDs as keys. Refer to \"Get Test Case Custom Fields\" to get available custom fields."
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"description": "Filter criteria for searching test cases"
},
"startAt": {
"type": "number",
"description": "Starting index for pagination (default 0)"
},
"maxResults": {
"type": "number",
"description": "Maximum results per page (default 50, max 100)"
},
"sort": {
"type": "string",
"description": "Sort field and order (e.g., key:asc)"
},
"fields": {
"type": "string",
"description": "summary,description,priority,status,assignee,isAutomated,reporter,estimatedTime,labels,folders,updated,created,executed"
}
},
"required": [
"filter"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
search-qmetry-test-cycle-folderSearch a Qmetry test cycle folder for a given projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"folderName": {
"type": "string",
"description": "Provide the actual folder name to search its details"
},
"mode": {
"type": "string",
"description": "Allowed value - \"STRICT\" ,if passed folder search will be absolute otherwise relative."
}
},
"required": [
"projectId",
"folderName"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
search-qmetry-test-cyclesSearch and list test cycles according to filtersInput schema{
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "The ID of the project"
},
"folderId": {
"type": "number",
"description": "Refer id from response of API \"Get Test Cycle folders\""
},
"searchText": {
"type": "string",
"description": "Search text for test cycle key"
},
"summary": {
"type": "string",
"description": "Test Cycle summary/name"
},
"status": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of status values"
},
"priority": {
"type": "string",
"description": "Priority of the test cycle"
},
"assignee": {
"type": "string",
"description": "Jira user Account ID"
},
"reporter": {
"type": "string",
"description": "Jira user Account ID"
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of label names"
},
"createdBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of user Account IDs who created"
},
"createdOn": {
"type": "string",
"description": "Creation date range (dd/MMM/yyyy,dd/MMM/yyyy)"
},
"updatedBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of user Account IDs who updated"
},
"updatedOn": {
"type": "string",
"description": "Update date range (dd/MMM/yyyy,dd/MMM/yyyy)"
},
"plannedStartDate": {
"type": "string",
"description": "Planned start date"
},
"plannedEndDate": {
"type": "string",
"description": "Planned end date"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields filter as array of objects with id and value. Refer to \"Get Test Cycle Custom Fields\" to get available custom fields."
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"description": "Filter criteria for searching test cycles"
},
"startAt": {
"type": "number",
"description": "Starting index for pagination (default 0)"
},
"maxResults": {
"type": "number",
"description": "Maximum results per page (default 50, max 100)"
},
"fields": {
"type": "string",
"description": "Comma separated fields to be fetched"
},
"sort": {
"type": "string",
"description": "Sort field and order (e.g., key:asc)"
}
},
"required": [
"filter"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
search-qmetry-test-plan-folderSearch a Qmetry test plan folder for a given projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get qmetry enabled projects\"."
},
"folderName": {
"type": "string",
"description": "Provide the actual folder name to search its details"
},
"mode": {
"type": "string",
"description": "Allowed value - \"STRICT\",if passed folder search will be absolute otherwise relative."
}
},
"required": [
"projectId",
"folderName"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
search-qmetry-test-plansSearch and list test plans according to filtersInput schema{
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "The ID of the project"
},
"folderId": {
"type": "number",
"description": "Refer id from response of API \"Get Test Plan folders\""
},
"summary": {
"type": "string",
"description": "Test Plan summary/name"
},
"status": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of status values"
},
"priority": {
"type": "string",
"description": "Priority of test plan"
},
"assignee": {
"type": "string",
"description": "Jira user Account ID"
},
"reporter": {
"type": "string",
"description": "Jira user Account ID"
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of label names"
},
"createdBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of user Account IDs who created"
},
"createdOn": {
"type": "string",
"description": "Creation date range (dd/MMM/yyyy,dd/MMM/yyyy)"
},
"updatedBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of user Account IDs who updated"
},
"updatedOn": {
"type": "string",
"description": "Update date range (dd/MMM/yyyy,dd/MMM/yyyy)"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields filter as array of objects with id and value. Refer to \"Get Test Plan Custom Fields\" to get available custom fields."
}
},
"required": [
"projectId"
],
"additionalProperties": false,
"description": "Filter criteria for searching test plans"
},
"startAt": {
"type": "number",
"description": "Starting index for pagination (default 0)"
},
"maxResults": {
"type": "number",
"description": "Maximum results per page (default 50, max 100)"
},
"fields": {
"type": "string",
"description": "Comma separated fields to be fetched, allowable fields are id, key, summary, description, projectId, folder, created, updated, labels, priority, status, reporter, testPlanFilterOperators"
},
"sort": {
"type": "string",
"description": "Sort field and order (e.g., key:asc)"
}
},
"required": [
"filter"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
unarchive-qmetry-test-caseUnarchive a test caseInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
unarchive-qmetry-test-cycleUnarchive a test cycleInput schema{
"type": "object",
"properties": {
"idOrKey": {
"type": "string",
"description": "Refer id or key from the response of API \"Search Test Cycles\""
}
},
"required": [
"idOrKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
unarchive-qmetry-test-planUnarchive a test planInput schema{
"type": "object",
"properties": {
"idOrKey": {
"type": "string",
"description": "Test Plan Id, refer id from response of API \"search Test Plans\""
}
},
"required": [
"idOrKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
unlink-qmetry-requirementsUnlink one or more requirements (Jira issues) from a specific test case in QmetryInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the test case to unlink requirements from. Refer id from the response of API \"Search Test Case\"."
},
"no": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
},
"requirementIds": {
"type": "array",
"items": {
"type": "number"
},
"description": "List of JIRA Issue Id which want to unlink from given test case. Example: [123, 456]"
}
},
"required": [
"id",
"no",
"requirementIds"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
unlink-requirements-from-test-cycleUnlink requirements (stories) from a test cycle. If any requirement cannot be unlinked then it will come under warningMessages obj of response.Input schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Cycle ID - Refer id from \"Search Test Cycles\""
},
"requirementIds": {
"type": "array",
"items": {
"type": "number"
},
"description": "List of Jira Issue Id which want to unlink from given test cycle"
},
"unLinkAll": {
"type": "boolean",
"description": "If it true then all linked requirements unlink with given test cycle"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
unlink-test-case-from-test-cycleUnlink test cases from a test cycleInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Cycle ID - Refer id from \"Search Test Cycles\""
},
"testCases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Case ID"
},
"versionNo": {
"type": "number",
"description": "Test Case Version Number"
}
},
"required": [
"id",
"versionNo"
],
"additionalProperties": false
},
"description": "List of test cases to unlink. Example: [{id: \"AYjI5KPIZpxE\", versionNo: 1}]"
},
"unlinkAll": {
"type": "boolean",
"description": "If true, unlinks all test cases"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
unlink-test-cycles-from-test-planUnlink test cycles from a test planInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Plan Id, refer id from response of API \"search Test Plans\""
},
"testcycleIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of test cycles ids can be found using \"search test cycles\""
}
},
"required": [
"id",
"testcycleIds"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
update-qmetry-labelUpdate an existing label in a Qmetry projectInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Name of LabelRefer id from the response of API \"Get QMetry Enabled Projects\"."
},
"labelId": {
"type": "number",
"description": "Refer id from the response of API \"Get labels\"."
},
"name": {
"type": "string",
"description": "Name of Label"
}
},
"required": [
"projectId",
"labelId",
"name"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
update-qmetry-test-caseUpdate a Qmetry test caseInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
},
"no": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
},
"status": {
"type": "number",
"description": "Refer id from the response of API \"Get Statuses\" for its module."
},
"priority": {
"type": "number",
"description": "Refer id from the response of API \"Get Priorities\"."
},
"assignee": {
"type": "string",
"description": "Jira user Account ID"
},
"description": {
"type": "string",
"description": "Description of Test Case"
},
"precondition": {
"type": "string",
"description": "precondition of Test Case"
},
"estimatedTime": {
"type": "string",
"description": "Pass string in HH:MM:SS format"
},
"folders": {
"type": "number",
"description": "Refer id from the response of API \"Get test case folders\"."
},
"labels": {
"type": "array",
"items": {
"type": "number"
},
"description": "Refer id from the response of API \"Get labels\"."
},
"sprint": {
"type": "number",
"description": "Jira sprint ID"
},
"summary": {
"type": "string",
"description": "Name of Test Case."
},
"isAutomated": {
"type": "boolean",
"description": "Whether testcase is automated or not - true or false"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields JSON object with field IDs as keys. Refer to \"Get Test Case Custom Fields\" to get available custom fields."
}
},
"required": [
"id",
"no"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
update-qmetry-test-case-statusUpdate an existing test case status in QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"statusId": {
"type": "number",
"description": "Refer id from the response of API \"Get statuses\"."
},
"name": {
"type": "string",
"description": "Status name"
},
"color": {
"type": "string",
"description": "New color code for the status (hex format)."
},
"description": {
"type": "string",
"description": "New description of the status."
}
},
"required": [
"projectId",
"statusId",
"name",
"color"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
update-qmetry-test-cycleUpdate an existing test cycleInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Cycles\""
},
"summary": {
"type": "string",
"description": "Test Cycle Summary"
},
"projectId": {
"type": "string",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\""
},
"folderId": {
"type": "number",
"description": "Refer id from the response of API \"Get Test Cycle folders\""
},
"priority": {
"type": "number",
"description": "Refer id from the response of API \"Get Priorities\""
},
"status": {
"type": "number",
"description": "Refer id from the response of API \"Get Test Cycle Status\""
},
"reporter": {
"type": "string",
"description": "Pass Jira user account uuid"
},
"labels": {
"type": "array",
"items": {
"type": "number"
},
"description": "Refer ids from the response of API \"Get Labels\". Will be sent as {add: [labelId1, ...]} to API"
},
"testCasesToLink": {
"type": "string",
"description": "Either list of test case Ids or search filter query"
},
"description": {
"type": "string",
"description": "Test Cycle description"
},
"plannedStartDate": {
"type": "string",
"description": "Enter in format dd/MMM/yyyy HH:mm. Example: 18/Oct/2025 09:00"
},
"plannedEndDate": {
"type": "string",
"description": "Enter in format dd/MMM/yyyy HH:mm. Example: 25/Oct/2025 17:00"
},
"actualTime": {
"type": "number",
"description": "Enter value in milliseconds"
},
"isAutomated": {
"type": "boolean",
"description": "Whether test cycle is automated or not"
},
"assignee": {
"type": "string",
"description": "Pass Jira user account uuid to assign test cycle to user"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields as array of objects with id and value. Refer to \"Get Test Cycle Custom Fields\" to get available custom fields."
}
},
"required": [
"id",
"summary",
"projectId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
update-qmetry-test-cycle-statusUpdate an existing test cycle status in QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"statusId": {
"type": "number",
"description": "Refer id from the response of API \"Get test cycle statuses\"."
},
"name": {
"type": "string",
"description": "Status name"
},
"color": {
"type": "string",
"description": "Status Color Ex. Hex code of color, refer JSON schema"
},
"description": {
"type": "string",
"description": "Status Description"
}
},
"required": [
"projectId",
"statusId",
"name",
"color"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
update-qmetry-test-planUpdate an existing test planInput schema{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Test Plan Id, refer id from response of API \"search Test Plans\""
},
"summary": {
"type": "string",
"description": "Test Plan Summary"
},
"folderId": {
"type": "number",
"description": "The ID of the folder"
},
"priority": {
"type": "number",
"description": "Priority Id"
},
"status": {
"type": "number",
"description": "Status Id"
},
"reporter": {
"type": "string",
"description": "Pass Jira user account uuid"
},
"labels": {
"type": "array",
"items": {
"type": "number"
},
"description": "Refer ids from the response of API \"Get Labels\". Will be sent as {add: [labelId1, ...]} to API"
},
"description": {
"type": "string",
"description": "Test Plan description"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom field ID"
},
"value": {
"type": "string",
"description": "Custom field value"
}
},
"required": [
"id",
"value"
],
"additionalProperties": false
},
"description": "Custom fields as array of objects with id and value. Refer to \"Get Test Plan Custom Fields\" to get available custom fields."
}
},
"required": [
"id"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
update-qmetry-test-plan-statusUpdate an existing test plan status in QMetryInput schema{
"type": "object",
"properties": {
"projectId": {
"type": "number",
"description": "Refer id from the response of API \"Get QMetry Enabled Projects\"."
},
"statusId": {
"type": "number",
"description": "Refer id from the response of API \"Get test plan statuses\"."
},
"name": {
"type": "string",
"description": "Status name"
},
"color": {
"type": "string",
"description": "Status Color Ex. Hex code of color, refer JSON schema"
},
"description": {
"type": "string",
"description": "Status Description"
}
},
"required": [
"projectId",
"statusId",
"name",
"color"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |
update-qmetry-test-stepUpdate a Qmetry test step for a given test caseInput schema{
"type": "object",
"properties": {
"testCaseId": {
"type": "string",
"description": "Refer id from the response of API \"Search Test Case\"."
},
"no": {
"type": "number",
"description": "Test Case version No. Refer {version.versionNo} from the response of API \"Search Test Case\"."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Test Step Id. Refer id from the response of API \"Get Test Steps\"."
},
"stepDetails": {
"type": "string",
"description": "Test step Details"
},
"testData": {
"type": "string",
"description": "Test step expected Result"
},
"expectedResult": {
"type": "string",
"description": "Test step test data"
}
},
"required": [
"id",
"stepDetails",
"testData",
"expectedResult"
],
"additionalProperties": false
}
}
},
"required": [
"testCaseId",
"no",
"steps"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
} | — | — · — | — |