OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Returns the folder for the given projectId with the specified Path along with its child folders. 4 # 5 # 6 # Arguments 7 # projectId: the project id of the Folder. 8 # testPlanId: the Test Plan id of the Folder. 9 # path: the path of the Folder. 10 (: String, : String, : String!): FolderResults 11 12 # Returns a Test by issueId. 13 # 14 # 15 # Arguments 16 # issueId: the id of the Test issue to be returned. 17 (: String): Test 18 19 # Returns multiple tests by jql, issue ids, project id or test type. 20 # 21 # 22 # Arguments 23 # jql: the jql that defines the search. 24 # issueIds: the ids of the Test issues to be returned. 25 # projectId: the id of the project of the Test issues to be returned. 26 # testType: the Test Type of the Test issues to be returned. 27 # modifiedSince: all tests modified after this date will be returned 28 # limit: the maximum amount of Tests to be returned. The maximum is 100. 29 # start: the index of the first item to return in the page of results (page offset). 30 # folder: the folder information required to filter the Test issues to be returned. 31 (: String, : [String], : String, : TestTypeInput, : String, : Int!, : Int, : FolderSearchInput): TestResults 32 33 # Returns a test (with the call test steps expanded) by issue id and version id. 34 # 35 # Arguments 36 # issueId: the id of the test issue to be returned. 37 # versionId: the id of a Test version. If not given, will get the default Test version. 38 (: String!, : Int): ExpandedTest 39 40 # Returns multiple tests (with the call test steps expanded) by jql, issue ids, project id or test type. 41 # 42 # 43 # 44 # Arguments 45 # jql: the jql that defines the search. 46 # issueIds: the ids of the Test issues with default Test versions to be returned. Cannot be used with tests. 47 # tests: the ids of the Test versions and Tests. If not given Test Version, will get the default Test version. Cannot be used with issueIds. 48 # projectId: the id of the project of the Test issues to be returned. 49 # testType: the Test Type of the Test issues to be returned. 50 # modifiedSince: all tests modified after this date will be returned 51 # limit: the maximum amount of Tests to be returned. The maximum is 100. 52 # start: the index of the first item to return in the page of results (page offset). 53 # folder: the folder information required to filter the Test issues to be returned. 54 ( 55 : String, 56 : [String], 57 : [TestWithVersionInput], 58 : String, 59 : TestTypeInput, 60 : String, 61 : Int!, 62 : Int, 63 : FolderSearchInput 64 ): ExpandedTestResults 65 66 # Returns a Coverable Issue by issueId. 67 # 68 # 69 # Arguments 70 # issueId: the id of the Coverable Issue to be returned. 71 (: String!): CoverableIssue 72 73 # Returns multiple coverable issues by jql or issue ids. 74 # 75 # Arguments 76 # jql: the jql that defines the search. 77 # issueIds: the ids of the Coverable Issues to be returned. 78 # limit: the maximum amount of Tests to be returned. The maximum is 100. 79 # start: the index of the first item to return in the page of results (page offset). 80 (: String, : [String], : Int!, : Int): CoverableIssueResults 81 82 # Returns a Dataset by its testIssueId. 83 # 84 # Arguments 85 # testIssueId: The unique identifier of the Dataset to be returned. 86 # testExecIssueId: (Optional) The unique identifier of the Test Execution. 87 # testPlanIssueId: (Optional) The unique identifier of the Test Plan. 88 # callTestIssueId: (Optional) The unique identifier of the Test Call. 89 (: String!, : String, : String, : String): Dataset 90 91 # Returns multiple Datasets based on optional filters. 92 # 93 # Arguments 94 # testIssueIds: Filter by test issue IDs. 95 # testExecIssueIds: (Optional) Filter by Test ExecutionIds. 96 # testPlanIssueIds: (Optional) Filter by Test PlanIds. 97 (: [String], : [String], : [String]): [Dataset] 98 99 # Returns a Precondition by issue id. 100 # 101 # 102 # Arguments 103 # issueId: the issue id of the Precondition to be returned. 104 (: String): Precondition 105 106 # Returns multiple Preconditions by jql, issueIds, projectId or Precondition Type. 107 # 108 # 109 # Arguments 110 # jql: the jql that defines the search. 111 # issueIds: the ids of the Precondition issues to be returned. 112 # projectId: the id of the project of the Precondition issues to be returned. 113 # preconditionType: the Precondition Type of the Precondition issues to be returned. 114 # limit: the maximum amount of Preconditions to be returned. The maximum is 100. 115 # start: the index of the first item to return in the page of results (page offset). 116 # modifiedSince: all Preconditions modified after this date will be returned 117 # folder: the folder information required to filter the Test issues to be returned. 118 ( 119 : String, 120 : [String], 121 : String, 122 : TestTypeInput, 123 : Int!, 124 : Int, 125 : String, 126 : PreconditionFolderSearchInput 127 ): PreconditionResults 128 129 # Returns a Test Set by issueId 130 # 131 # 132 # Arguments 133 # issueId: the id of the Test Set issue to be returned. 134 (: String): TestSet 135 136 # Returns multiple Test Sets by jql, issueIds or projectId. 137 # 138 # 139 # Arguments 140 # jql: the jql that defines the search. 141 # issueIds: the ids of the Test Set issues to be returned. 142 # projectId: the id of the project of the Test Set issues to be returned. 143 # limit: the maximum amount of Test Sets to be returned. The maximum is 100. 144 # start: the index of the first item to return in the page of results (page offset). 145 # modifiedSince: all test sets modified after this date will be returned 146 (: String, : [String], : String, : Int!, : Int, : String): TestSetResults 147 148 # Returns a Test Plan by issue id. 149 # 150 # 151 # Arguments 152 # issueId: the issue id of the Test Plan issue to be returned. 153 (: String): TestPlan 154 155 # Returns multiple Test Plans by jql, issue ids or project id. 156 # 157 # 158 # Arguments 159 # jql: the jql that defines the search. 160 # issueIds: the ids of the Test Plan issues to be returned. 161 # projectId: the id of the project of the Test Plan issues to be returned. 162 # limit: the maximum amount of Test Plans to be returned. The maximum is 100. 163 # start: the index of the first item to return in the page of results (page offset). 164 # modifiedSince: all Test Plans modified after this date will be returned 165 (: String, : [String], : String, : Int!, : Int, : String): TestPlanResults 166 167 # Returns a Test Execution by issue id. 168 # 169 # 170 # Arguments 171 # issueId: the id of the Test Execution issue to be returned. 172 (: String): TestExecution 173 174 # Returns multiple Test Executions by jql, issue ids or project id. 175 # 176 # 177 # Arguments 178 # jql: the jql that defines the search. 179 # issueIds: the ids of the Test Executions issues to be returned. 180 # projectId: the id of the project of the Test Execution issues to be returned. 181 # limit: the maximum amount of Test Executions to be returned. The maximum is 100. 182 # start: the index of the first item to return in the page of results (page offset). 183 # modifiedSince: all Test Executions modified after this date will be returned 184 (: String, : [String], : String, : Int!, : Int, : String): TestExecutionResults 185 186 # Returns a Test Run by Test issue id and Test Execution issue id. 187 # 188 # Arguments 189 # testIssueId: the issue id of the Test of the Test Run. 190 # testExecIssueId: the issue id of the Test Execution of the Test Run. 191 (: String, : String): TestRun 192 193 # Returns a Test Run by id. 194 # 195 # Arguments 196 # id: the id of the Test Run. 197 (: String): TestRun 198 199 # Returns multiple Test Runs testIssueIds and/or testExecIssueIds. 200 # 201 # 202 # Arguments 203 # testIssueIds: the issue ids of the Test of the Test Runs. 204 # testExecIssueIds: the issue ids of the Test Execution of the Test Runs. 205 # testRunAssignees: the user account ids of the assignee of the Test Runs. 206 # statuses: the status ids of the Test Runs (e.g. PASSED, FAILED, TODO, EXECUTING, or custom status id). 207 # testPlanIssueIds: the issue ids of the Test Plans whose Test Runs should be returned. 208 # limit: the maximum amount of Test Runs to be returned. The maximum is 100. 209 # start: the index of the first item to return in the page of results (page offset). 210 # modifiedSince: all TestRuns modified after this date will be returned 211 (: [String], : [String], : [String], : [String], : [String], : Int!, : Int, : String): TestRunResults 212 213 # Returns multiple Test Runs by id. 214 # 215 # Arguments 216 # ids: the ids of the Test Runs. 217 # limit: the maximum amount of Test Runs to be returned. The maximum is 100. 218 # start: the index of the first item to return in the page of results (page offset). 219 (: [String], : Int!, : Int): TestRunResults 220 221 # Returns a Status by Test Run Step Status name. 222 # 223 # Arguments 224 # name: the status name of test run step status 225 (: String): StepStatus 226 227 # Returns a Status by Test Run Status name. 228 # 229 # Arguments 230 # name: the status name of Test Run Status 231 (: String): Status 232 233 # Returns all Test Run Status. 234 # 235 # Arguments 236 # projectId: the project id to get statuses for. If not provided, returns global statuses 237 (: String): [Status] 238 239 # Returns all Test Run Step Status. 240 # 241 # Arguments 242 # projectId: the project id to get step statuses for. If not provided, returns global step statuses 243 (: String): [StepStatus] 244 245 # Returns the Project Settings of a Project. 246 # 247 # Arguments 248 # projectIdOrKey: Project Id 249 (: String): ProjectSettings 250 251 # Returns the Project Settings of multiple Projects. 252 # 253 # Arguments 254 # projectIdsOrKeys: Project Ids or Keys 255 # limit: the maximum amount of Project Settings to be returned. The maximum is 100. 256 # start: the index of the first item to return in the page of results (page offset). 257 (: [String], : Int!, : Int): ProjectsSettingsResults 258 259 # Returns the Issue Link Types 260 : [IssueLinkType] 261 262 # Get Manual Step Library steps with optional text search. 263 # Either projectId or testIssueId must be provided. 264 # 265 # Example: 266 # { 267 # 268 # getManualStepLibrary(projectId: "10000", search: "login", limit: 10) { 269 # 270 # total 271 # 272 # start 273 # 274 # limit 275 # 276 # results { 277 # 278 # id 279 # 280 # action 281 # 282 # data 283 # 284 # result 285 # 286 # } 287 # 288 # } 289 # } 290 # 291 # Arguments 292 # projectId: The project id. Either this or testIssueId must be provided. 293 # search: Search text to match against step fields (action, data, result, description, labels). 294 # testIssueId: Filter steps linked to a specific test issue. Either this or projectId must be provided. 295 # limit: The maximum amount of steps to be returned. The maximum is 100. 296 # start: The index of the first item to return in the page of results (page offset). 297 (: String, : String, : String, : Int!, : Int): ManualStepLibraryResults 298 299 # Get BDD Step Library steps with optional text search. 300 # Either projectId or testIssueId must be provided. 301 # 302 # Example: 303 # { 304 # 305 # getBDDStepLibrary(projectId: "10000", search: "login", limit: 10) { 306 # 307 # total 308 # 309 # start 310 # 311 # limit 312 # 313 # results { 314 # 315 # id 316 # 317 # definition 318 # 319 # labels 320 # 321 # lastModified 322 # 323 # associatedTests 324 # 325 # library { id name isGlobal } 326 # 327 # } 328 # 329 # } 330 # } 331 # 332 # Arguments 333 # projectId: The project id. Either this or testIssueId must be provided. 334 # search: Search text to match against step definition. 335 # testIssueId: Filter steps linked to a specific test issue. Either this or projectId must be provided. 336 # limit: The maximum amount of steps to be returned. The maximum is 100. 337 # start: The index of the first item to return in the page of results (page offset). 338 (: String, : String, : String, : Int!, : Int): BDDStepLibraryResults 339 340 }