OBJECT
Mutation
link GraphQL Schema definition
1 type Mutation { 2 3 # Mutation used to create a new Folder. 4 # 5 # 6 # 7 # Arguments 8 # projectId: the project id of the Folder. 9 # testPlanId: the Test Plan id of the Folder. 10 # path: the path of the Folder. 11 # testIssueIds: the Test ids to add to the Folder. 12 # issueIds: the Test or Precondition ids to add to the Folder. 13 (: String, : String, : String!, : [String], : [String]): ActionFolderResult 14 15 # Mutation used to delete a Folder. 16 # 17 # Arguments 18 # projectId: the project id of the Folder. 19 # testPlanId: the Test Plan id of the Folder. 20 # path: the path of the Folder. 21 (: String, : String, : String!): String 22 23 # Mutation used to rename a Folder. 24 # 25 # Arguments 26 # projectId: the project id of the Folder. 27 # testPlanId: the Test Plan id of the Folder. 28 # path: the path of the Folder. 29 # newName: the new name of the Folder. 30 (: String, : String, : String!, : String!): ActionFolderResult 31 32 # Mutation used to move a Folder. 33 # 34 # Arguments 35 # projectId: the project id of the Folder. 36 # testPlanId: the Test Plan id of the Folder. 37 # path: the path of the Folder. 38 # destinationPath: the new path of the Folder. 39 # index: the index of where to insert the folder in. 40 (: String, : String, : String!, : String!, : Int): ActionFolderResult 41 42 # Mutation used to add tests to a Folder. 43 # 44 # Arguments 45 # projectId: the project id of the Folder. 46 # testPlanId: the Test Plan id of the Folder. 47 # path: the path of the Folder. 48 # testIssueIds: the Test ids to add to the Folder. 49 # index: the index of where to insert the Tests in. 50 (: String, : String, : String!, : [String]!, : Int): ActionFolderResult 51 52 # Mutation used to add issues to a Folder. 53 # 54 # Arguments 55 # projectId: the project id of the Folder. 56 # path: the path of the Folder. 57 # issueIds: the Test or Precondition ids to add to the Folder. 58 # index: the index of where to insert the Tests in. 59 (: String!, : String!, : [String]!, : Int): ActionFolderResult 60 61 # Mutation used to remove tests from Folder. 62 # 63 # Arguments 64 # projectId: the project id of the Folder. 65 # testPlanId: the Test Plan id of the Folder. 66 # testIssueIds: the Test ids to remove from the Folder. 67 (: String, : String, : [String]!): String 68 69 # Mutation used to remove issues from Folder. 70 # 71 # Arguments 72 # projectId: the project id of the Folder. 73 # issueIds: the Test or Precondition ids to remove from the Folder. 74 (: String!, : [String]!): String 75 76 # Mutation used to create a new Test. 77 # 78 # 79 # Arguments 80 # testType: the Test Type of the Test. 81 # steps: the Step definition of the test. 82 # unstructured: the unstructured definition of the Test. 83 # gherkin: the gherkin definition of the Test. 84 # preconditionIssueIds: the Precondition ids that be associated with the Test. 85 # folderPath: the Test repository folder for the Test. 86 # jira: the Jira object that will be used to create the Test. 87 # Check this Jira endpoint for more information related with this field. 88 (: UpdateTestTypeInput, : [CreateStepInput], : String, : String, : [String], : String, : JSON!): CreateTestResult 89 90 # Mutation used to update the Test Type of a Test. 91 # 92 # 93 # Arguments 94 # issueId: the issue id of the Test. 95 # versionId: the id of a Test version. If not given, will update the default Test version. 96 # testType: the Test Type to update on the Test. 97 (: String!, : Int, : UpdateTestTypeInput!): Test 98 99 # Mutation used to update the Unstructured definition of a Test. 100 # 101 # 102 # Arguments 103 # issueId: the issue id of the Test. 104 # versionId: the id of a Test version. If not given, will update the default Test version. 105 # unstructured: the unstructured definition of the Test. 106 (: String!, : Int, : String!): Test 107 108 # Mutation used to update the Gherkin definition of a Test. 109 # 110 # 111 # Arguments 112 # issueId: the issue id of the Test. 113 # versionId: the id of a Test version. If not given, will update the default Test version. 114 # gherkin: the gherkin definition of the Test. 115 (: String!, : Int, : String!): Test 116 117 # Mutation used to delete a Test. 118 # 119 # Arguments 120 # issueId: the issue id of the Test. 121 (: String!): String 122 123 # Mutation used to add a Step to a Test. 124 # 125 # 126 # Arguments 127 # issueId: the issue id of the Test. 128 # versionId: the id of a Test version. If not given, will update the default Test version. 129 # step: the Step to add to the Test. 130 (: String!, : Int, : CreateStepInput!): Step 131 132 # Mutation used to update a Step of a Test. 133 # 134 # Arguments 135 # stepId: the id of the Step. 136 # step: the information to update on the Step. 137 (: String!, : UpdateStepInput!): UpdateTestStepResult 138 139 # Mutation used to remove a Step from a Test. 140 # 141 # Arguments 142 # stepId: the id of the Step. 143 (: String!): String 144 145 # Mutation used to remove all Steps from a Test. 146 # 147 # 148 # Arguments 149 # issueId: the id of the Step. 150 # versionId: the id of a Test version. If not given, will update the default Test version. 151 (: String!, : Int): String 152 153 # Mutation used to associate Preconditions to the Test. 154 # Note: The preconditions to be associated with the Test must be of the same Test Type of the Test. 155 # 156 # 157 # Arguments 158 # issueId: the issue id of the Test. 159 # versionId: the id of a Test version. If not given, will update the default Test version. 160 # preconditionIssueIds: the issue ids of the Preconditions. 161 (: String!, : Int, : [String]!): AddPreconditionsResult 162 163 # Mutation used to remove Preconditions from the Test. 164 # 165 # 166 # Arguments 167 # issueId: the issue id of the Test. 168 # versionId: the id of a Test version. If not given, will update the default Test version. 169 # preconditionIssueIds: the issue ids of the Preconditions. 170 (: String!, : Int, : [String]!): String 171 172 # Mutation used update the Test folder on the Test Repository. 173 # 174 # Arguments 175 # issueId: the issue id of the Test. 176 # folderPath: the Test repository folder for the Test. 177 (: String!, : String!): String 178 179 # Mutation used update the precondition folder on the Test Repository. 180 # 181 # Arguments 182 # issueId: the issue id of the Precondition. 183 # folderPath: the Test repository folder for the Precondition. 184 (: String!, : String!): String 185 186 # Mutation used to associate Test Sets to the Test. 187 # 188 # Arguments 189 # issueId: the issue id of the Test. 190 # testSetIssueIds: the issue ids of the Test Sets. 191 (: String!, : [String]!): AddTestSetsResult 192 193 # Mutation used to remove Test Sets from the Test. 194 # 195 # Arguments 196 # issueId: the issue id of the Test. 197 # testSetIssueIds: the issue ids of the Test Sets. 198 (: String!, : [String]!): String 199 200 # Mutation used to associate Test Plans to the Test. 201 # 202 # Arguments 203 # issueId: the issue id of the Test. 204 # testPlanIssueIds: the issue ids of the Test Plans. 205 (: String!, : [String]!): AddTestPlansResult 206 207 # Mutation used to remove Test Plans from the Test. 208 # 209 # Arguments 210 # issueId: the issue id of the Test. 211 # testPlanIssueIds: the issue ids of the Test Plans. 212 (: String!, : [String]!): String 213 214 # Mutation used to associate Test Executions to the Test. 215 # 216 # 217 # Arguments 218 # issueId: the issue id of the Test. 219 # versionId: the id of a Test version. If not given, will update the default Test version. 220 # testExecIssueIds: the issue ids of the Test Executions. 221 (: String!, : Int, : [String]!): AddTestExecutionsResult 222 223 # Mutation used to remove Test Executions from the Test. 224 # 225 # Arguments 226 # issueId: the issue id of the Test. 227 # testExecIssueIds: the issue ids of the Test Executions. 228 (: String!, : [String]!): String 229 230 # Mutation used to create a new Precondition. 231 # 232 # Arguments 233 # preconditionType: the Precondition Type of the Precondition issue. 234 # definition: the definition of the Precondition issue. 235 # testIssueIds: the Test issue ids to be associated with the Precondition issue. Will associate the default Test versions. Cannot be used with tests. 236 # tests: the Test versions to be associated with the Precondition. Cannot be used with testIssueIds. 237 # folderPath: the Test repository folder for the Precondition. 238 # jira: the jira object that will be used to create the Precondition. 239 # Check this Jira endpoint for more information related with this field. 240 (: UpdatePreconditionTypeInput, : String, : [String], : [TestWithVersionInput], : String, : JSON!): CreatePreconditionResult 241 242 # Mutation used to update a Precondition 243 # 244 # 245 # Arguments 246 # issueId: the issue id of the Precondition. 247 # data: the object containing the information to update the Precondition. 248 (: String!, : UpdatePreconditionInput): Precondition 249 250 # Mutation used to delete a Precondition 251 # 252 # Arguments 253 # issueId: the issue id of the Precondition. 254 (: String!): String 255 256 # Mutation used to associate Tests to the Precondition. One of testIssueIds or tests is required. 257 # Note: The Tests to be associated with the Precondition must be of the same Test Type of the Precondition. 258 # 259 # 260 # Arguments 261 # issueId: the issue id of the Precondition. 262 # testIssueIds: the issue ids of the Tests. Will associate the default Test versions. Cannot be used with tests. 263 # tests: the ids of the Test versions. Cannot be used with testIssueIds. 264 (: String!, : [String], : [TestWithVersionInput]): AddTestsResult 265 266 # Mutation used to remove Tests from the Precondition. One of testIssueIds or tests is required. 267 # 268 # 269 # Arguments 270 # issueId: the issue id of the Precondition. 271 # testIssueIds: the issue ids of the Tests. Will remove the default Test versions. Cannot be used with tests. 272 # tests: the ids of the Test versions. Cannot be used with testIssueIds. 273 (: String!, : [String], : [TestWithVersionInput]): String 274 275 # Mutation used to create a new Test Set. 276 # 277 # Arguments 278 # testIssueIds: the Test ids that will be associated with the Test Set. 279 # jira: the Jira object that will be used to create the Test Set. 280 # Check this Jira endpoint for more information related with this field. 281 (: [String], : JSON!): CreateTestSetResult 282 283 # Mutation used to delete a Test Set 284 # 285 # Arguments 286 # issueId: The issue id of the Test Set. 287 (: String!): String 288 289 # Mutation used to associate Tests to the Test Set. 290 # 291 # Arguments 292 # issueId: the issue id of the Test Set. 293 # testIssueIds: the issue ids of the Tests. 294 (: String!, : [String]!): AddTestsResult 295 296 # Mutation used to remove Tests from the Test Set. 297 # 298 # Arguments 299 # issueId: the issue id of the Test Set. 300 # testIssueIds: the issue ids of the Tests. 301 (: String!, : [String]!): String 302 303 # Mutation used to create a new Test Plan. 304 # 305 # Arguments 306 # savedFilter: the saved filter id or name that will be used to configure the Test Plan. Cannot be used with testIssueIds. 307 # testIssueIds: the test issue ids that will be associated with the Test Plan. Cannot be used with savedFilter. 308 # jira: the Jira object that will be used to create the Test Plan. 309 # Check this Jira endpoint for more information related with this field. 310 (: String, : [String], : JSON!): CreateTestPlanResult 311 312 # Mutation used to delete a Test Plan. 313 # 314 # Arguments 315 # issueId: issue id of the Test Plan. 316 (: String!): String 317 318 # Mutation used to associate Tests to the Test Plan. 319 # 320 # Arguments 321 # issueId: the issue id of the Test Plan. 322 # testIssueIds: the issue ids of the Tests. 323 (: String!, : [String]!): AddTestsResult 324 325 # Mutation used to remove Tests from the Test Plan. 326 # 327 # Arguments 328 # issueId: the issue id of the Test Plan. 329 # testIssueIds: the issue ids of the Tests. 330 (: String!, : [String]!): String 331 332 # Mutation used to associate Test Executions to the Test Plan. 333 # 334 # Arguments 335 # issueId: the issue id of the Test Plan. 336 # testExecIssueIds: the issue ids of the Test Executions. 337 (: String!, : [String]!): AddTestExecutionsResult 338 339 # Mutation used to remove Test Executions from the Test Plan. 340 # 341 # Arguments 342 # issueId: the issue id of the Test Plan. 343 # testExecIssueIds: the issue ids of the Test Executions. 344 (: String!, : [String]!): String 345 346 # Mutation used to create a new Test Execution. 347 # 348 # Arguments 349 # testIssueIds: the test issue ids that will be associated with the Test Execution. Cannot be used with tests. 350 # tests: the Test versions to be associated with the Test Execution. Cannot be used with testIssueIds. 351 # testEnvironments: the test environments to be added to the Test Execution. 352 # jira: the Jira object that will be used to create the Test Execution. 353 # Check this Jira endpoint for more information related with this field. 354 (: [String], : [TestWithVersionInput], : [String], : JSON!): CreateTestExecutionResult 355 356 # Mutation used to delete a Test Execution. 357 # 358 # Arguments 359 # issueId: the issue id of the Test Execution. 360 (: String!): String 361 362 # Mutation used to associate Tests to the Test Execution. One of testIssueIds or tests is required. 363 # 364 # Arguments 365 # issueId: the issue id of the Test Execution. 366 # testIssueIds: the ids of the Tests. Will associate the default Test versions. Cannot be used with tests. 367 # tests: the ids of the Test versions. Cannot be used with testIssueIds. 368 (: String!, : [String], : [TestWithVersionInput]): AddTestsResult 369 370 # Mutation used to remove Tests from the Test Execution. 371 # 372 # Arguments 373 # issueId: issue id of the Test Execution. 374 # testIssueIds: the ids of the Tests. 375 (: String!, : [String]!): String 376 377 # Mutation used to add Test Environments to the Test Execution. 378 # 379 # Arguments 380 # issueId: the issue id of the Test Execution. 381 # testEnvironments: the test environments to add. 382 (: String!, : [String]!): AddTestEnvironmentsResult 383 384 # Mutation used to remove Test Environments from the Test Execution. 385 # 386 # Arguments 387 # issueId: the issue id of the Test Execution. 388 # testEnvironments: the test environments to remove 389 (: String!, : [String]!): String 390 391 # Mutation used to reset the Test Run. This will load the new test definition and delete the current execution data. 392 # 393 # Arguments 394 # id: the id of the Test Run. 395 (: String!): String 396 397 # Mutation used to update the status of a Test Run. 398 # 399 # Arguments 400 # id: the id of the Test Run. 401 # status: the id or name of the status of the Test Run. 402 (: String!, : String!): String 403 404 # Mutation used to update the comment of a Test Run. 405 # 406 # Arguments 407 # id: the id of the Test Run. 408 # comment: the comment of the Test Run. 409 (: String!, : String!): String 410 411 # Mutation used to update a Test Run. 412 # 413 # Arguments 414 # id: the id of the Test Run. 415 # comment: the comment of the Test Run. 416 # startedOn: the startedOn of the Test Run. 417 # finishedOn: the finishedOn of the Test Run. 418 # assigneeId: the assignee of the Test Run. 419 # executedById: the executedBy of the Test Run. 420 # customFields: the customFields of the Test Run. 421 (: String!, : String, : String, : String, : String, : String, : [CustomFieldInput]): UpdateTestRunResult 422 423 # Mutation used to add defects to a Test Run. 424 # 425 # Arguments 426 # id: the id of the Test Run. 427 # issues: the ids or keys of the defects to add to the Test Run. 428 (: String!, : [String]!): AddDefectsResult 429 430 # Mutation used to remove defects from a Test Run. 431 # 432 # Arguments 433 # id: the id of the Test Run. 434 # issues: the ids or keys of the defects to remove from the Test Run. 435 (: String!, : [String]!): String 436 437 # Mutation used to add evidence to a Test Run. 438 # 439 # Arguments 440 # id: the id of the Test Run. 441 # evidence: the evidence to add to the Test Run. 442 (: String!, : [AttachmentDataInput]!): AddEvidenceResult 443 444 # Mutation used to remove evidence from a Test Run. 445 # 446 # Arguments 447 # id: the id of the Test Run. 448 # evidenceIds: the ids of the evidence to remove from the Test Run. 449 # evidenceFilenames: the filenames of the evidence to remove from the Test Run. 450 (: String!, : [String], : [String]): RemoveEvidenceResult 451 452 # Mutation used to update the Test Run Step. 453 # 454 # Arguments 455 # testRunId: The id of the Test Run. 456 # stepId: the id of the Test Run Step. 457 # updateData: the update information. 458 # iterationRank: the rank of the iteration. 459 (: String!, : String!, : UpdateTestRunStepInput!, : String): UpdateTestRunStepResult 460 461 # Mutation used to add evidence to a Test Run Step. 462 # 463 # Arguments 464 # testRunId: The id of the Test Run. 465 # stepId: the id of the Test Run Step. 466 # evidence: the evidence to add to the Test Run Step. 467 # iterationRank: the rank of the iteration. 468 (: String!, : String!, : [AttachmentDataInput], : String): AddEvidenceResult 469 470 # Mutation used to remove evidence from a Test Run Step. 471 # 472 # Arguments 473 # testRunId: The id of the Test Run. 474 # stepId: the id of the Test Run Step. 475 # iterationRank: the rank of the iteration. 476 # evidenceIds: the id of the evidence. 477 # evidenceFilenames: the filename of the evidence. 478 (: String!, : String!, : String, : [String], : [String]): RemoveEvidenceResult 479 480 # Mutation used to add defects to a Test Run Step. 481 # 482 # Arguments 483 # testRunId: The id of the Test Run. 484 # stepId: the id of the Test Run Step. 485 # issues: the ids or keys of the defects. 486 # iterationRank: the rank of the iteration. 487 (: String!, : String!, : [String], : String): AddDefectsResult 488 489 # Mutation used to remove defects from a Test Run. 490 # 491 # Arguments 492 # testRunId: The id of the Test Run. 493 # stepId: the id of the Test Run Step. 494 # issues: the ids or keys of the defects. 495 # iterationRank: the rank of the iteration. 496 (: String!, : String!, : [String]!, : String): RemoveDefectsResult 497 498 # Mutation used to update the comment of a Test Run Step. 499 # 500 # Arguments 501 # testRunId: The id of the Test Run. 502 # stepId: the id of the Test Run Step. 503 # comment: the comment of the Test Run Step. 504 # iterationRank: the rank of the iteration. 505 (: String!, : String!, : String!, : String): String 506 507 # Mutation used to update the status of a Test Run Step. 508 # 509 # Arguments 510 # testRunId: The id of the Test Run. 511 # stepId: the id of the Test Run Step. 512 # status: the id or name of the status of the Test Run. 513 # iterationRank: the rank of the iteration. 514 (: String!, : String!, : String!, : String): UpdateTestRunStepStatusResult 515 516 # Mutation used to update the status of a Test Run Example. 517 # 518 # Arguments 519 # exampleId: the id of the Test Run Example. 520 # status: the id or name of the status of the Test Run. 521 (: String!, : String!): UpdateTestRunExampleStatusResult 522 523 # Mutation used to update the status of a Test Run iteration. 524 # 525 # Arguments 526 # testRunId: The id of the Test Run. 527 # iterationRank: The rank of the iteration. 528 # status: the id or name of the status of the iteration. 529 (: String!, : String!, : String!): UpdateIterationStatusResult 530 531 # Mutation used to set the timer in Test Run. This will start, pause or stop the timer in Test Run. 532 # 533 # Arguments 534 # testRunId: the id of the Test Run. 535 # running: to start (true) or pause (false) the timer 536 # reset: to stop the timer 537 (: String!, : Boolean, : Boolean): String 538 539 }