OBJECT

Mutation

link GraphQL Schema definition

1type Mutation {
2
3# Mutation used to create a new Folder.
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# testIssueIds: the Test ids to add to the Folder.
11createFolder(projectId: String, testPlanId: String, path: String!, testIssueIds: [String]): ActionFolderResult
12
13# Mutation used to delete a Folder.
14#
15# Arguments
16# projectId: the project id of the Folder.
17# testPlanId: the Test Plan id of the Folder.
18# path: the path of the Folder.
19deleteFolder(projectId: String, testPlanId: String, path: String!): String
20
21# Mutation used to rename a Folder.
22#
23# Arguments
24# projectId: the project id of the Folder.
25# testPlanId: the Test Plan id of the Folder.
26# path: the path of the Folder.
27# newName: the new name of the Folder.
28renameFolder(projectId: String, testPlanId: String, path: String!, newName: String!): ActionFolderResult
29
30# Mutation used to move a Folder.
31#
32# Arguments
33# projectId: the project id of the Folder.
34# testPlanId: the Test Plan id of the Folder.
35# path: the path of the Folder.
36# destinationPath: the new path of the Folder.
37# index: the index of where to insert the folder in.
38moveFolder(projectId: String, testPlanId: String, path: String!, destinationPath: String!, index: Int): ActionFolderResult
39
40# Mutation used to add tests a Folder.
41#
42# Arguments
43# projectId: the project id of the Folder.
44# testPlanId: the Test Plan id of the Folder.
45# path: the path of the Folder.
46# testIssueIds: the Test ids to add to the Folder.
47# index: the index of where to insert the Tests in.
48addTestsToFolder(projectId: String, testPlanId: String, path: String!, testIssueIds: [String]!, index: Int): ActionFolderResult
49
50# Mutation used to remove tests from Folder.
51#
52# Arguments
53# projectId: the project id of the Folder.
54# testPlanId: the Test Plan id of the Folder.
55# testIssueIds: the Test ids to remove from the Folder.
56removeTestsFromFolder(projectId: String, testPlanId: String, testIssueIds: [String]!): String
57
58# Mutation used to create a new Test.
59#
60#
61# Arguments
62# testType: the Test Type of the Test.
63# steps: the Step definition of the test.
64# unstructured: the unstructured definition of the Test.
65# gherkin: the gherkin definition of the Test.
66# preconditionIssueIds: the Precondition ids that be associated with the Test.
67# folderPath: the Test repository folder for the Test.
68# jira: the Jira object that will be used to create the Test.
69# Check this Jira endpoint for more information related with this field.
70createTest(testType: UpdateTestTypeInput, steps: [CreateStepInput], unstructured: String, gherkin: String, preconditionIssueIds: [String], folderPath: String, jira: JSON!): CreateTestResult
71
72# Mutation used to update the Test Type of a Test.
73#
74# Arguments
75# issueId: the issue id of the Test.
76# testType: the Test Type to update on the Test.
77updateTestType(issueId: String!, testType: UpdateTestTypeInput!): Test
78
79# Mutation used to update the Unstructured definition of a Test.
80#
81# Arguments
82# issueId: the issue id of the Test.
83# unstructured: the unstructured definition of the Test.
84updateUnstructuredTestDefinition(issueId: String!, unstructured: String!): Test
85
86# Mutation used to update the Gherkin definition of a Test.
87#
88# Arguments
89# issueId: the issue id of the Test.
90# gherkin: the gherkin definition of the Test.
91updateGherkinTestDefinition(issueId: String!, gherkin: String!): Test
92
93# Mutation used to delete a Test.
94#
95# Arguments
96# issueId: the issue id of the Test.
97deleteTest(issueId: String!): String
98
99# Mutation used to add a Step to a Test.
100#
101# Arguments
102# issueId: the issue id of the Test.
103# step: the Step to add to the Test.
104addTestStep(issueId: String!, step: CreateStepInput!): Step
105
106# Mutation used to update a Step of a Test.
107#
108# Arguments
109# stepId: the id of the Step.
110# step: the information to update on the Step.
111updateTestStep(stepId: String!, step: UpdateStepInput!): UpdateTestStepResult
112
113# Mutation used to remove a Step from a Test.
114#
115# Arguments
116# stepId: the id of the Step.
117removeTestStep(stepId: String!): String
118
119# Mutation used to remove all Steps from a Test.
120#
121# Arguments
122# issueId: the id of the Step.
123removeAllTestSteps(issueId: String!): String
124
125# Mutation used to associate Preconditions to the Test.
126# Note: The preconditions to be associated with the Test must be of the same Test Type of the Test.
127#
128# Arguments
129# issueId: the issue id of the Test.
130# preconditionIssueIds: the issue ids of the Preconditions.
131addPreconditionsToTest(issueId: String!, preconditionIssueIds: [String]!): AddPreconditionsResult
132
133# Mutation used to remove Preconditions from the Test.
134#
135# Arguments
136# issueId: the issue id of the Test.
137# preconditionIssueIds: the issue ids of the Preconditions.
138removePreconditionsFromTest(issueId: String!, preconditionIssueIds: [String]!): String
139
140# Mutation used update the Test folder on the Test Repository.
141#
142# Arguments
143# issueId: the issue id of the Test.
144# folderPath: the Test repository folder for the Test.
145updateTestFolder(issueId: String!, folderPath: String!): String
146
147# Mutation used to associate Test Sets to the Test.
148#
149# Arguments
150# issueId: the issue id of the Test.
151# testSetIssueIds: the issue ids of the Test Sets.
152addTestSetsToTest(issueId: String!, testSetIssueIds: [String]!): AddTestSetsResult
153
154# Mutation used to remove Test Sets from the Test.
155#
156# Arguments
157# issueId: the issue id of the Test.
158# testSetIssueIds: the issue ids of the Test Sets.
159removeTestSetsFromTest(issueId: String!, testSetIssueIds: [String]!): String
160
161# Mutation used to associate Test Plans to the Test.
162#
163# Arguments
164# issueId: the issue id of the Test.
165# testPlanIssueIds: the issue ids of the Test Plans.
166addTestPlansToTest(issueId: String!, testPlanIssueIds: [String]!): AddTestPlansResult
167
168# Mutation used to remove Test Plans from the Test.
169#
170# Arguments
171# issueId: the issue id of the Test.
172# testPlanIssueIds: the issue ids of the Test Plans.
173removeTestPlansFromTest(issueId: String!, testPlanIssueIds: [String]!): String
174
175# Mutation used to associate Test Executions to the Test.
176#
177# Arguments
178# issueId: the issue id of the Test.
179# testExecIssueIds: the issue ids of the Test Executions.
180addTestExecutionsToTest(issueId: String!, testExecIssueIds: [String]!): AddTestExecutionsResult
181
182# Mutation used to remove Test Executions from the Test.
183#
184# Arguments
185# issueId: the issue id of the Test.
186# testExecIssueIds: the issue ids of the Test Executions.
187removeTestExecutionsFromTest(issueId: String!, testExecIssueIds: [String]!): String
188
189# Mutation used to create a new Precondition.
190#
191# Arguments
192# preconditionType: the Precondition Type of the Precondition issue.
193# definition: the definition of the Precondition issue.
194# testIssueIds: the Test issue ids to be associated with the Precondition issue.
195# jira: the jira object that will be used to create the Test.
196# Check this Jira endpoint for more information related with this field.
197createPrecondition(preconditionType: UpdatePreconditionTypeInput, definition: String, testIssueIds: [String], jira: JSON!): CreatePreconditionResult
198
199# Mutation used to update a Precondition
200#
201# Arguments
202# issueId: the issue id of the Precondition.
203# data: the object containing the information to update the Precondition.
204updatePrecondition(issueId: String!, data: UpdatePreconditionInput): Precondition
205
206# Mutation used to delete a Precondition
207#
208# Arguments
209# issueId: the issue id of the Precondition.
210deletePrecondition(issueId: String!): String
211
212# Mutation used to associate Tests to the Precondition.
213# Note: The Tests to be associated with the Precondition must be of the same Test Type of the Precondition.
214#
215# Arguments
216# issueId: the issue id of the Precondition.
217# testIssueIds: the issue ids of the Tests.
218addTestsToPrecondition(issueId: String!, testIssueIds: [String]!): AddTestsResult
219
220# Mutation used to remove Tests from the Precondition.
221#
222# Arguments
223# issueId: the issue id of the Precondition.
224# testIssueIds: the issue ids of the Tests.
225removeTestsFromPrecondition(issueId: String!, testIssueIds: [String]!): String
226
227# Mutation used to create a new Test Set.
228#
229# Arguments
230# testIssueIds: the Test ids that will be associated with the Test Set.
231# jira: the Jira object that will be used to create the Test Set.
232# Check this Jira endpoint for more information related with this field.
233createTestSet(testIssueIds: [String], jira: JSON!): CreateTestSetResult
234
235# Mutation used to delete a Test Set
236#
237# Arguments
238# issueId: The issue id of the Test Set.
239deleteTestSet(issueId: String!): String
240
241# Mutation used to associate Tests to the Test Set.
242#
243# Arguments
244# issueId: the issue id of the Test Set.
245# testIssueIds: the issue ids of the Tests.
246addTestsToTestSet(issueId: String!, testIssueIds: [String]!): AddTestsResult
247
248# Mutation used to remove Tests from the Test Set.
249#
250# Arguments
251# issueId: the issue id of the Test Set.
252# testIssueIds: the issue ids of the Tests.
253removeTestsFromTestSet(issueId: String!, testIssueIds: [String]!): String
254
255# Mutation used to create a new Test Plan.
256#
257# Arguments
258# testIssueIds: the test issue ids that will be associated with the Test Plan.
259# jira: the Jira object that will be used to create the Test Plan.
260# Check this Jira endpoint for more information related with this field.
261createTestPlan(testIssueIds: [String], jira: JSON!): CreateTestPlanResult
262
263# Mutation used to delete a Test Plan.
264#
265# Arguments
266# issueId: issue id of the Test Plan.
267deleteTestPlan(issueId: String!): String
268
269# Mutation used to associate Tests to the Test Plan.
270#
271# Arguments
272# issueId: the issue id of the Test Plan.
273# testIssueIds: the issue ids of the Tests.
274addTestsToTestPlan(issueId: String!, testIssueIds: [String]!): AddTestsResult
275
276# Mutation used to remove Tests from the Test Plan.
277#
278# Arguments
279# issueId: the issue id of the Test Plan.
280# testIssueIds: the issue ids of the Tests.
281removeTestsFromTestPlan(issueId: String!, testIssueIds: [String]!): String
282
283# Mutation used to associate Test Executions to the Test Plan.
284#
285# Arguments
286# issueId: the issue id of the Test Plan.
287# testExecIssueIds: the issue ids of the Test Executions.
288addTestExecutionsToTestPlan(issueId: String!, testExecIssueIds: [String]!): AddTestExecutionsResult
289
290# Mutation used to remove Test Executions from the Test Plan.
291#
292# Arguments
293# issueId: the issue id of the Test Plan.
294# testExecIssueIds: the issue ids of the Test Executions.
295removeTestExecutionsFromTestPlan(issueId: String!, testExecIssueIds: [String]!): String
296
297# Mutation used to create a new Test Execution.
298#
299# Arguments
300# testIssueIds: the test issue ids that will be associated with the Test Execution.
301# testEnvironments: the test environments to be added to the Test Execution.
302# jira: the Jira object that will be used to create the Test Execution.
303# Check this Jira endpoint for more information related with this field.
304createTestExecution(testIssueIds: [String], testEnvironments: [String], jira: JSON!): CreateTestExecutionResult
305
306# Mutation used to delete a Test Execution.
307#
308# Arguments
309# issueId: the issue id of the Test Execution.
310deleteTestExecution(issueId: String!): String
311
312# Mutation used to associate Tests to the Test Execution.
313#
314# Arguments
315# issueId: the issue id of the Test Execution.
316# testIssueIds: the ids of the Tests.
317addTestsToTestExecution(issueId: String!, testIssueIds: [String]!): AddTestsResult
318
319# Mutation used to remove Tests from the Test Execution.
320#
321# Arguments
322# issueId: issue id of the Test Execution.
323# testIssueIds: the ids of the Tests.
324removeTestsFromTestExecution(issueId: String!, testIssueIds: [String]!): String
325
326# Mutation used to add Test Environments to the Test Execution.
327#
328# Arguments
329# issueId: the issue id of the Test Execution.
330# testEnvironments: the test environments to add.
331addTestEnvironmentsToTestExecution(issueId: String!, testEnvironments: [String]!): AddTestEnvironmentsResult
332
333# Mutation used to remove Test Environments from the Test Execution.
334#
335# Arguments
336# issueId: the issue id of the Test Execution.
337# testEnvironments: the test environments to remove
338removeTestEnvironmentsFromTestExecution(issueId: String!, testEnvironments: [String]!): String
339
340# Mutation used to reset the Test Run. This will load the new test definition and delete the current execution data.
341#
342# Arguments
343# id: the id of the Test Run.
344resetTestRun(id: String!): String
345
346# Mutation used to update the status of a Test Run.
347#
348# Arguments
349# id: the id of the Test Run.
350# status: the id or name of the status of the Test Run.
351updateTestRunStatus(id: String!, status: String!): String
352
353# Mutation used to update the comment of a Test Run.
354#
355# Arguments
356# id: the id of the Test Run.
357# comment: the comment of the Test Run.
358updateTestRunComment(id: String!, comment: String!): String
359
360# Mutation used to update a Test Run.
361#
362# Arguments
363# id: the id of the Test Run.
364# comment: the comment of the Test Run.
365# startedOn: the startedOn of the Test Run.
366# finishedOn: the finishedOn of the Test Run.
367# assigneeId: the assignee of the Test Run.
368# executedById: the executedBy of the Test Run.
369# customFields: the customFields of the Test Run.
370updateTestRun(id: String!, comment: String, startedOn: String, finishedOn: String, assigneeId: String, executedById: String, customFields: [CustomFieldInput]): UpdateTestRunResult
371
372# Mutation used to add defects to a Test Run.
373#
374# Arguments
375# id: the id of the Test Run.
376# issues: the ids or keys of the defects to add to the Test Run.
377addDefectsToTestRun(id: String!, issues: [String]!): AddDefectsResult
378
379# Mutation used to remove defects from a Test Run.
380#
381# Arguments
382# id: the id of the Test Run.
383# issues: the ids or keys of the defects to remove from the Test Run.
384removeDefectsFromTestRun(id: String!, issues: [String]!): String
385
386# Mutation used to add evidence to a Test Run.
387#
388# Arguments
389# id: the id of the Test Run.
390# evidence: the evidence to add to the Test Run.
391addEvidenceToTestRun(id: String!, evidence: [AttachmentDataInput]!): AddEvidenceResult
392
393# Mutation used to remove evidence from a Test Run.
394#
395# Arguments
396# id: the id of the Test Run.
397# evidenceIds: the ids of the evidence to remove from the Test Run.
398# evidenceFilenames: the filenames of the evidence to remove from the Test Run.
399removeEvidenceFromTestRun(id: String!, evidenceIds: [String], evidenceFilenames: [String]): RemoveEvidenceResult
400
401# Mutation used to update the Test Run Step.
402#
403# Arguments
404# testRunId: The id of the Test Run.
405# stepId: the id of the Test Run Step.
406# updateData: the update information.
407# iterationRank: the rank of the iteration.
408updateTestRunStep(testRunId: String!, stepId: String!, updateData: UpdateTestRunStepInput!, iterationRank: String): UpdateTestRunStepResult
409
410# Mutation used to add evidence to a Test Run Step.
411#
412# Arguments
413# testRunId: The id of the Test Run.
414# stepId: the id of the Test Run Step.
415# evidence: the evidence to add to the Test Run Step.
416# iterationRank: the rank of the iteration.
417addEvidenceToTestRunStep(testRunId: String!, stepId: String!, evidence: [AttachmentDataInput], iterationRank: String): AddEvidenceResult
418
419# Mutation used to remove evidence from a Test Run Step.
420#
421# Arguments
422# testRunId: The id of the Test Run.
423# stepId: the id of the Test Run Step.
424# iterationRank: the rank of the iteration.
425# evidenceIds: the id of the evidence.
426# evidenceFilenames: the filename of the evidence.
427removeEvidenceFromTestRunStep(testRunId: String!, stepId: String!, iterationRank: String, evidenceIds: [String], evidenceFilenames: [String]): RemoveEvidenceResult
428
429# Mutation used to add defects to a Test Run Step.
430#
431# Arguments
432# testRunId: The id of the Test Run.
433# stepId: the id of the Test Run Step.
434# issues: the ids or keys of the defects.
435# iterationRank: the rank of the iteration.
436addDefectsToTestRunStep(testRunId: String!, stepId: String!, issues: [String], iterationRank: String): AddDefectsResult
437
438# Mutation used to remove defects from a Test Run.
439#
440# Arguments
441# testRunId: The id of the Test Run.
442# stepId: the id of the Test Run Step.
443# issues: the ids or keys of the defects.
444# iterationRank: the rank of the iteration.
445removeDefectsFromTestRunStep(testRunId: String!, stepId: String!, issues: [String]!, iterationRank: String): RemoveDefectsResult
446
447# Mutation used to update the comment of a Test Run Step.
448#
449# Arguments
450# testRunId: The id of the Test Run.
451# stepId: the id of the Test Run Step.
452# comment: the comment of the Test Run Step.
453# iterationRank: the rank of the iteration.
454updateTestRunStepComment(testRunId: String!, stepId: String!, comment: String!, iterationRank: String): String
455
456# Mutation used to update the status of a Test Run Step.
457#
458# Arguments
459# testRunId: The id of the Test Run.
460# stepId: the id of the Test Run Step.
461# status: the id or name of the status of the Test Run.
462# iterationRank: the rank of the iteration.
463updateTestRunStepStatus(testRunId: String!, stepId: String!, status: String!, iterationRank: String): UpdateTestRunStepStatusResult
464
465# Mutation used to update the status of a Test Run Example.
466#
467# Arguments
468# exampleId: the id of the Test Run Example.
469# status: the id or name of the status of the Test Run.
470updateTestRunExampleStatus(exampleId: String!, status: String!): UpdateTestRunExampleStatusResult
471
472# Mutation used to update the status of a Test Run iteration.
473#
474# Arguments
475# testRunId: The id of the Test Run.
476# iterationRank: The rank of the iteration.
477# status: the id or name of the status of the iteration.
478updateIterationStatus(testRunId: String!, iterationRank: String!, status: String!): UpdateIterationStatusResult
479
480}