{ "opencollection": "1.0.0", "info": { "name": "qTest Manager API Version 3.0 Test Case API", "version": "v3.0" }, "items": [ { "info": { "name": "test-case", "type": "folder" }, "items": [ { "info": { "name": "Gets multiple Test Cases", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "parentId", "value": "", "type": "query", "description": "Module ID" }, { "name": "page", "value": "", "type": "query", "description": "By default the first page is returned. However, you can specify any page number to retrieve test cases." }, { "name": "size", "value": "", "type": "query", "description": "The result is paginated. By the default, the number of requirements in each page is 20.\n\nYou can specify your custom number in this parameter." }, { "name": "expandProps", "value": "", "type": "query", "description": "By default, Test Case properties are included in the response. specify expandProps=false to exclude them" }, { "name": "expandSteps", "value": "", "type": "query", "description": "By default, Test Steps are excluded from the response body. Input expandSteps=true to include Test Steps" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." }, { "name": "utc", "value": "", "type": "query" }, { "name": "modifiedAfter", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve all Test Cases or Test Cases which are located directly under a Module" }, { "info": { "name": "Creates a Test Case", "type": "http" }, "http": { "method": "POST", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "agentId", "value": "", "type": "query" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." }, { "name": "aiGenerated", "value": "", "type": "query", "description": "Indicates that the contents of the Test Step were created using an Artificial Intelligence service." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To create a Test Case\n\nqTest Manager version: 4+" }, { "info": { "name": "Updates multiple test cases", "type": "http" }, "http": { "method": "PUT", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/update/testcases", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To update multiple Test Cases\n\nqTest Manager version: 6+" }, { "info": { "name": "Gets all Comments of a Test Case", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:idOrKey/comments", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "idOrKey", "value": "", "type": "path", "description": "PID or ID of the Test Case whose comments you want to retrieve" }, { "name": "page", "value": "", "type": "query", "description": "By default the first page is returned but you can specify any page number to retrieve objects" }, { "name": "pageSize", "value": "", "type": "query", "description": "The result is paginated. By the default, the number of objects in each page is 100 if this is omitted. You can specify your custom number (up to 999) in this parameter" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve all comments of a Test Case\n\nqTest Manager version: 7.5+" }, { "info": { "name": "Adds a Comment to a Test Case", "type": "http" }, "http": { "method": "POST", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:idOrKey/comments", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "idOrKey", "value": "", "type": "path", "description": "PID or ID of the Test Case" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To add a Comment to a Test Case\n\nqTest Manager version: 7.5+" }, { "info": { "name": "Gets a Comment of a Test Case", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:idOrKey/comments/:commentId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "idOrKey", "value": "", "type": "path", "description": "PID or ID of the Test Case" }, { "name": "commentId", "value": "", "type": "path", "description": "ID of the comment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve a comment of a Test Case\n\nqTest Manager version: 7.5+" }, { "info": { "name": "Updates a Comment of a Test Case", "type": "http" }, "http": { "method": "PUT", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:idOrKey/comments/:commentId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "idOrKey", "value": "", "type": "path", "description": "PID or ID of the Test Case" }, { "name": "commentId", "value": "", "type": "path", "description": "ID of the comment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To modify a comment of a Test Case\n\nqTest Manager version: 7.5+" }, { "info": { "name": "Deletes a Comment of a Test Case", "type": "http" }, "http": { "method": "DELETE", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:idOrKey/comments/:commentId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "idOrKey", "value": "", "type": "path", "description": "PID or ID of the Test Case" }, { "name": "commentId", "value": "", "type": "path", "description": "ID of the comment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To delete a comment of a Test Case\n\nqTest Manager version: 7.5+" }, { "info": { "name": "Gets a Test Case", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "PID or ID of the Test Case" }, { "name": "versionId", "value": "", "type": "query", "description": "ID of the Test Case version" }, { "name": "expand", "value": "", "type": "query", "description": "By default, Test Steps are excluded from the response. Specify expand=teststep to include Test Steps" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve a Test Case\n\nqTest Manager version: 6+" }, { "info": { "name": "Updates a Test Case", "type": "http" }, "http": { "method": "PUT", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case which needs to be updated." }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To update a Test Case\n\nqTest Manager version: 6+" }, { "info": { "name": "Deletes a Test Case", "type": "http" }, "http": { "method": "DELETE", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case which needs to be deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To delete Test Case\n\nqTest Manager version: 6+" }, { "info": { "name": "Approves a Test Case", "type": "http" }, "http": { "method": "PUT", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId/approve", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To approve a Test Case\n\nqTest Manager version: 7.4+" }, { "info": { "name": "Gets Test Steps of a Test Case", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId/test-steps", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve all Test Steps of a Test Case's latest version\n\nqTest Manager version: 6+" }, { "info": { "name": "Creates a Test Step", "type": "http" }, "http": { "method": "POST", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId/test-steps", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To add a Test Step to a Test Case's latest version\n\nqTest Manager version: 6+" }, { "info": { "name": "Gets a Test Step", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId/test-steps/:stepId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" }, { "name": "stepId", "value": "", "type": "path", "description": "ID of the test step. \n\nThe ObjectId of customFieldInfo is used as a StepId here." }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve a Test Step of a Test Case's latest version\n\nqTest Manager version: 6+" }, { "info": { "name": "Update a Test Step", "type": "http" }, "http": { "method": "PUT", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId/test-steps/:stepId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" }, { "name": "stepId", "value": "", "type": "path", "description": "ID of the Test Step" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To update a Test Step of a Test Case's latest version\n\nqTest Manager version: 6+" }, { "info": { "name": "Deletes a Test Step", "type": "http" }, "http": { "method": "DELETE", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId/test-steps/:stepId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" }, { "name": "stepId", "value": "", "type": "path", "description": "ID of the Test Step" }, { "name": "updateVersion", "value": "", "type": "query", "description": "If specified updateVersion=true, then the test case version will be updated when the test step is deleted." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To delete a test step of a Test Case\n\nqTest Manager version: 6+" }, { "info": { "name": "test-case.vera.approve", "type": "http" }, "http": { "method": "PUT", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId/vera/approve", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "test-case.vera.approve" }, { "info": { "name": "Gets all versions of a Test Case", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId/versions", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the test case" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get all versions of a Test Case.\n\nExample:\n\nAPI returns all approved major test case versions and the last unapproved minor version if there is one.\n\n
  • if version history is 1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 3.2; it will only return versions 1.0, 2.0, 3.0 and 3.2
  • if the version history is 1.0, 1.1, 2.0, 2.1, 2.2, 3.0; it will only return versions 1.0, 2.0, and 3.0
  • if the version history is 0.1, 0.2, 0.3, 0.4; it will only return version 0.4
    • qTest Manager version:[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve a specific version of a Test Case\n\nqTest Manager version: 4+" }, { "info": { "name": "Gets Test Steps of a Test Case version", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/test-cases/:testCaseId/versions/:versionId/test-steps", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" }, { "name": "versionId", "value": "", "type": "path", "description": "ID of the Test Case version" }, { "name": "expand", "value": "", "type": "query", "description": "when you Specify expand=calledteststep \n\nIt will include Test Steps of the called Test Cases in your response." }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve all Test Steps of a specific Test Case version" }, { "info": { "name": "Gets Test Steps of a Test Case", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v4/projects/:projectId/test-cases/:testCaseId/test-steps", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" }, { "name": "page", "value": "", "type": "query", "description": "By default the first page is returned but you can specify any page number to retrieve objects" }, { "name": "size", "value": "", "type": "query", "description": "size" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve all Test Steps of a Test Case's latest version\n\nqTest Manager version: 6+" }, { "info": { "name": "Gets Test Steps of a Test Case version", "type": "http" }, "http": { "method": "GET", "url": "https://apitryout.qtestnet.com/api/v4/projects/:projectId/test-cases/:testCaseId/versions/:versionId/test-steps", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "ID of the project" }, { "name": "testCaseId", "value": "", "type": "path", "description": "ID of the Test Case" }, { "name": "versionId", "value": "", "type": "path", "description": "ID of the Test Case version" }, { "name": "expand", "value": "", "type": "query", "description": "when you Specify expand=calledteststep \n\nIt will include Test Steps of the called Test Cases in your response." }, { "name": "page", "value": "", "type": "query", "description": "By default the first page is returned but you can specify any page number to retrieve objects" }, { "name": "size", "value": "", "type": "query", "description": "size" }, { "name": "showParamIdentifier", "value": "", "type": "query", "description": "By default, Parameters in Test Steps are displayed in ID number mode (like \"[~123]\"). Input showParamIdentifier=true to change to Identifier text mode. Result should be like \"[~myIdentifier]\"." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "To retrieve all Test Steps of a specific Test Case version" } ] } ], "bundled": true }